aapi package #

static field(name: str)#

static field_optional(name: str, default: str | None = None)#

object_name: str#

static type_field(name: str)#

class aapi.ai.AIJob(object_name: str, connection_profile: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

connection_profile: str#

static field(name: str)#

static field_optional(name: str, default: str | None = None)#

object_name: str#

static type_field(name: str)#

aapi.basefolder module#

class aapi.basefolder.Folder(object_name: str, *, controlm_server: str = None, order_method: OrderMethod = None, folder_library: str = None, site_standard: str = None, business_fields: List[Dict[str, str]] = NOTHING, job_list: List[Job] = NOTHING, flow_list: List[Flow] = NOTHING, folder_client_data_list: List[FolderClientData] = NOTHING, priority: Priority = None, application: str = None, created_by: str = None, confirm: bool = None, days_keep_active: str = None, description: str = None, days_keep_active_if_not_ok: str = None, active_retention_policy: ActiveRetentionPolicy = None, run_as: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, member_library: str = None, statistics_calendar: str = None, sac: Sac = None, must_end: MustEnd = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, adjust_events: str = None, when: When = None, if_list: List[IfBase] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, resource_lock_list: List[ResourceLock] = NOTHING, sub_folder_list: List[SubFolder] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING)#

Bases: SimpleFolder, AAPIJob

class ActiveRetentionPolicy(value)#

Bases: Enum

An enumeration.

CleanEndedOK = 'CleanEndedOK'#

KeepAll = 'KeepAll'#

class AdjustEvents(value)#

Bases: Enum

An enumeration.

Bridge = 'Bridge'#

Dummy = 'Dummy'#

N = 'N'#

Y = 'Y'#

class DaysKeepActive(value)#

Bases: Enum

An enumeration.

Forever = 'Forever'#

class DocumentationFile(*, path: str | None = None, file_name: str | None = None)#

Bases: AAPIObject

file_name: str#

path: str#

class DocumentationUrl(*, url: str | None = None, file_name: str | None = None)#

Bases: AAPIObject

file_name: str#

url: str#

class MustEnd(*, hours: str | None = None, minutes: str | None = None, days: int | None = None)#

Bases: AAPIObject

days: int#

hours: str#

minutes: str#

class Priority(value)#

Bases: Enum

An enumeration.

High = 'High'#

Low = 'Low'#

Medium = 'Medium'#

Very_High = 'Very_High'#

Very_Low = 'Very_Low'#

class Rerun(*, times: str = None, every: str = None, from_: From = None, units: Units = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

class Units(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

every: str#

from_: From#

times: str#

units: Units#

class RerunIntervals(*, times: str = None, intervals: List[str] = None, from_: From = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

from_: From#

intervals: List[str]#

times: str#

class RerunLimit(*, times: str = None, every: int = None, from_: From = None, units: Units = None, rerun_member: str = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

class Units(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

every: int#

from_: From#

rerun_member: str#

times: str#

units: Units#

class RerunSpecificTimes(*, times: str | None = None, at: List[str] | None = None, tolerance: str | None = None)#

Bases: AAPIObject

at: List[str]#

times: str#

tolerance: str#

class Sac(value)#

Bases: Enum

An enumeration.

Default = 'Default'#

Next = 'Next'#

Prev = 'Prev'#

SmartFolderNext = 'SmartFolderNext'#

SmartFolderPrev = 'SmartFolderPrev'#

class When(*, schedule: str = None, month_days: List[str] = None, months: List[str] = None, week_days: List[str] = None, week_days_calendar: str = None, month_days_calendar: str = None, days_relation: DaysRelation = None, specific_dates: List[str] = None, from_time: str = None, days: str = None, to_time: str = None, start_date: str = None, end_date: str = None, active_period: bool = None, rule_based_calendars: RuleBasedCalendars = None)#

Bases: AAPIObject

class DaysRelation(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

class RuleBasedCalendars(*, included: List[TagGlobal] = None, excluded: List[TagGlobal] = None, calendar_rule_based_list: List[CalendarRuleBased] = NOTHING)#

Bases: AAPIObject

calendar_rule_based_list: List[CalendarRuleBased]#

excluded: List[TagGlobal]#

included: List[TagGlobal]#

active_period: bool#

days: str#

days_relation: DaysRelation#

end_date: str#

from_time: str#

month_days: List[str]#

month_days_calendar: str#

months: List[str]#

rule_based_calendars: RuleBasedCalendars#

schedule: str#

specific_dates: List[str]#

start_date: str#

to_time: str#

week_days: List[str]#

week_days_calendar: str#

active_retention_policy: ActiveRetentionPolicy#

add_events_list: List[AddEvents]#

adjust_events: str#

application: str#

confirm: bool#

created_by: str#

days_keep_active: str#

days_keep_active_if_not_ok: str#

delete_events_list: List[DeleteEvents]#

description: str#

documentation_file: DocumentationFile#

documentation_url: DocumentationUrl#

events_to_add: List[AddEvents]#

events_to_delete: List[DeleteEvents]#

if_list: List[IfBase]#

member_library: str#

must_end: MustEnd#

notify_list: List[Notify]#

object_name: str#

priority: Priority#

rerun: Rerun#

rerun_intervals: RerunIntervals#

rerun_limit: RerunLimit#

rerun_specific_times: RerunSpecificTimes#

resource_lock_list: List[ResourceLock]#

run_as: str#

sac: Sac#

statistics_calendar: str#

sub_application: str#

sub_folder_list: List[SubFolder]#

time_zone: str#

variables: List[Dict[str, str]]#

wait_for_events: List[WaitForEvents]#

wait_for_events_list: List[WaitForEvents]#

when: When#

class aapi.basefolder.SimpleFolder(object_name: str, *, controlm_server: str = None, order_method: OrderMethod = None, folder_library: str = None, site_standard: str = None, business_fields: List[Dict[str, str]] = NOTHING, job_list: List[Job] = NOTHING, flow_list: List[Flow] = NOTHING, folder_client_data_list: List[FolderClientData] = NOTHING)#

Bases: AAPIObject

class OrderMethod(value)#

Bases: Enum

An enumeration.

Automatic = 'Automatic'#

Manual = 'Manual'#

business_fields: List[Dict[str, str]]#

controlm_server: str#

flow_list: List[Flow]#

folder_client_data_list: List[FolderClientData]#

folder_library: str#

job_list: List[Job]#

object_name: str#

order_method: OrderMethod#

site_standard: str#

aapi.bases module#

class aapi.bases.AAPIJob#: Bases: object

class aapi.bases.AAPIObject#

Bases: object

as_aapi_dict()#

as_dict()#

dump_aapi(f, indent=None)#

dumps_aapi(indent=None)#

aapi.businessfield module#

class aapi.businessfield.BusinessField(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.businessparameter module#

class aapi.businessparameter.BusinessParameter(object_name: str, *, parameter_name: str = None, include: Include = None, characters: Characters = None, exclude: Exclude = None, required: bool = None)#

Bases: AAPIObject

class Characters(*, minimum_length: int = None, maximum_length: int = None, any: Any = None, alphanumeric: Alphanumeric = None)#

Bases: AAPIObject

class Alphanumeric(*, uppercase_letters: bool | None = None, lowercase_letters: bool | None = None, digits: bool | None = None, specific_characters: str | None = None)#

Bases: AAPIObject

digits: bool#

lowercase_letters: bool#

specific_characters: str#

uppercase_letters: bool#

class Any(*, except_for_characters: str | None = None)#

Bases: AAPIObject

except_for_characters: str#

alphanumeric: Alphanumeric#

any: Any#

maximum_length: int#

minimum_length: int#

class Exclude(*, values: List[SiteStandardPossibleValue] = None, patterns: List[str] = None)#

Bases: AAPIObject

patterns: List[str]#

values: List[SiteStandardPossibleValue]#

class Include(*, values: List[SiteStandardPossibleValue] = None, patterns: List[str] = None)#

Bases: AAPIObject

patterns: List[str]#

values: List[SiteStandardPossibleValue]#

characters: Characters#

exclude: Exclude#

include: Include#

object_name: str#

parameter_name: str#

required: bool#

aapi.calendar module#

class aapi.calendar.Calendar(object_name: str)#

Bases: AAPIObject

object_name: str#

class aapi.calendar.CalendarPeriodic(object_name: str, *, when: When = None, server: Server = None, alias: str = None, description: str = None)#

Bases: Calendar

class Server(value)#

Bases: Enum

An enumeration.

Global = 'Global'#

class When(*, periods: List[Period] = None)#

Bases: AAPIObject

periods: List[Period]#

alias: str#

description: str#

object_name: str#

server: Server#

when: When#

class aapi.calendar.CalendarRegular(object_name: str, *, when: When = None, server: Server = None, alias: str = None, description: str = None)#

Bases: Calendar

class Server(value)#

Bases: Enum

An enumeration.

Global = 'Global'#

class When(*, years: List[Year] = None)#

Bases: AAPIObject

years: List[Year]#

alias: str#

description: str#

object_name: str#

server: Server#

when: When#

class aapi.calendar.CalendarRuleBased(object_name: str, *, when: When = None)#

Bases: Calendar

class When(*, specific_dates: List[str] = None, schedule: str = None, month_days: List[str] = None, months: List[str] = None, week_days: List[str] = None, week_days_calendar: str = None, month_days_calendar: str = None, days_relation: DaysRelation = None, start_date: str = None, end_date: str = None, active_period: bool = None, days_keep_active: DaysKeepActive = None, confirmation_calendars: ConfirmationCalendars = None)#

Bases: AAPIObject

class ConfirmationCalendars(*, calendar: str = None, shift_by: int = None, exception_policy: ExceptionPolicy = None)#

Bases: AAPIObject

class ExceptionPolicy(value)#

Bases: Enum

An enumeration.

DoNotOrder = 'DoNotOrder'#

OrderAnyway = 'OrderAnyway'#

OrderOnNextConfirmedDay = 'OrderOnNextConfirmedDay'#

OrderOnPreviousConfirmedDay = 'OrderOnPreviousConfirmedDay'#

calendar: str#

exception_policy: ExceptionPolicy#

shift_by: int#

class DaysKeepActive(value)#

Bases: Enum

An enumeration.

Forever = 'Forever'#

class DaysRelation(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

active_period: bool#

confirmation_calendars: ConfirmationCalendars#

days_keep_active: DaysKeepActive#

days_relation: DaysRelation#

end_date: str#

month_days: List[str]#

month_days_calendar: str#

months: List[str]#

schedule: str#

specific_dates: List[str]#

start_date: str#

week_days: List[str]#

week_days_calendar: str#

object_name: str#

when: When#

class aapi.calendar.CalendarRuleBasedCalendar(object_name: str, *, when: When = None, server: Server = None, alias: str = None)#

Bases: Calendar

class Server(value)#

Bases: Enum

An enumeration.

Global = 'Global'#

class When(*, schedule: str = None, month_days: List[str] = None, months: List[str] = None, week_days: List[str] = None, week_days_calendar: str = None, month_days_calendar: str = None, days_relation: DaysRelation = None, start_date: str = None, end_date: str = None, active_period: bool = None, specific_dates: List[str] = None, days_keep_active: DaysKeepActive = None, confirmation_calendars: ConfirmationCalendars = None)#

Bases: AAPIObject

class ConfirmationCalendars(*, calendar: str = None, shift_by: int = None, exception_policy: ExceptionPolicy = None)#

Bases: AAPIObject

class ExceptionPolicy(value)#

Bases: Enum

An enumeration.

DoNotOrder = 'DoNotOrder'#

OrderAnyway = 'OrderAnyway'#

OrderOnNextConfirmedDay = 'OrderOnNextConfirmedDay'#

OrderOnPreviousConfirmedDay = 'OrderOnPreviousConfirmedDay'#

calendar: str#

exception_policy: ExceptionPolicy#

shift_by: int#

class DaysKeepActive(value)#

Bases: Enum

An enumeration.

Forever = 'Forever'#

class DaysRelation(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

active_period: bool#

confirmation_calendars: ConfirmationCalendars#

days_keep_active: DaysKeepActive#

days_relation: DaysRelation#

end_date: str#

month_days: List[str]#

month_days_calendar: str#

months: List[str]#

schedule: str#

specific_dates: List[str]#

start_date: str#

week_days: List[str]#

week_days_calendar: str#

alias: str#

object_name: str#

server: Server#

when: When#

aapi.calendarfields module#

class aapi.calendarfields.CalendarFields(object_name: str)#

Bases: AAPIObject

object_name: str#

class aapi.calendarfields.CalendarFieldsPeriodic(object_name: str)#

Bases: CalendarFields

object_name: str#

class aapi.calendarfields.CalendarFieldsRegular(object_name: str)#

Bases: CalendarFields

object_name: str#

class aapi.calendarfields.CalendarFieldsRuleBased(object_name: str)#

Bases: CalendarFields

object_name: str#

aapi.calendarkey module#

class aapi.calendarkey.CalendarKey(object_name: str)#

Bases: AAPIObject

object_name: str#

class aapi.calendarkey.CalendarKeyPeriodic(object_name: str)#

Bases: CalendarKey

object_name: str#

class aapi.calendarkey.CalendarKeyRegular(object_name: str)#

Bases: CalendarKey

object_name: str#

class aapi.calendarkey.CalendarKeyRuleBased(object_name: str)#

Bases: CalendarKey

object_name: str#

aapi.captureoutput module#

class aapi.captureoutput.ActionCaptureOutput(object_name: str, *, variable_name: VariableName = None, search: str = None, forward_by: ForwardBy = None, capture: Capture = None)#

Bases: AAPIObject

class Capture(value)#

Bases: Enum

An enumeration.

UpToEndOfLine = 'UpToEndOfLine'#

var_ = 'var_'#

class ForwardBy(*, lines: int = None, columns: int = None, columns_option: ColumnsOption = None, delimiter: Delimiter = None)#

Bases: AAPIObject

class ColumnsOption(value)#

Bases: Enum

An enumeration.

Characters = 'Characters'#

Words = 'Words'#

class Delimiter(value)#

Bases: Enum

An enumeration.

Space = 'Space'#

Tab = 'Tab'#

WhiteSpace = 'WhiteSpace'#

var_ = 'var_'#

columns: int#

columns_option: ColumnsOption#

delimiter: Delimiter#

lines: int#

class VariableName(value)#

Bases: Enum

An enumeration.

var_ = 'var_'#

capture: Capture#

forward_by: ForwardBy#

object_name: str#

search: str#

variable_name: VariableName#

aapi.condition module#

class aapi.condition.Condition(*, event: str = None, date: Date = None)#

Bases: AAPIObject

class Date(value)#

Bases: Enum

An enumeration.

AnyDate = 'AnyDate'#

NextOrderDate = 'NextOrderDate'#

NoDate = 'NoDate'#

OrderDate = 'OrderDate'#

PreviousOrderDate = 'PreviousOrderDate'#

date: Date#

event: str#

class aapi.condition.ConditionIn(*, event: str = None, date: Date = None)#: Bases: Condition

class aapi.condition.ConditionOut(*, event: str = None, date: Date = None)#: Bases: Condition

class aapi.condition.ConditionOutAdd(*, event: str = None, date: Date = None)#: Bases: ConditionOut

class aapi.condition.ConditionOutDelete(*, event: str = None, date: Date = None)#: Bases: ConditionOut

aapi.config module#

class aapi.config.Config(object_name: str)#

Bases: AAPIObject

object_name: str#

class aapi.config.ConfigHadoop(object_name: str, *, agent_principal: str | None = None, agent_keytab_file_path: str | None = None)#

Bases: Config

agent_keytab_file_path: str#

agent_principal: str#

object_name: str#

aapi.connectionprofile module#

Bases: AAPIObject

centralized: bool#

description: str#

no_test_on_deploy: bool#

object_name: str#

target_agent: str#

target_ctm: str#

test_on_build: bool#

class aapi.connectionprofile.ConnectionProfileAWS(object_name: str, region: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, access_key: str = None, secret_access_key: str = None, iam_role: str = None, proxy_settings: ProxySettings = None)#

class ProxySettings(host: str, port: int, username: str, password: str)#

Bases: AAPIObject

host: str#

password: str#

port: int#

username: str#

access_key: str#

iam_role: str#

object_name: str#

proxy_settings: ProxySettings#

region: str#

secret_access_key: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileAirflowGoogleComposer(object_name: str, service_account_key: str, base_url: str, target_audience: str, *, target_ctm: str | None = None, target_agent: str | None = None, test_on_build: bool | None = None, no_test_on_deploy: bool | None = None, description: str | None = None, centralized: bool | None = None, service_account_key_filename: str | None = None)#

Bases: ConnectionProfileAirflow

base_url: str#

object_name: str#

service_account_key: str#

service_account_key_filename: str#

target_audience: str#

class aapi.connectionprofile.ConnectionProfileAirflowStandalone(object_name: str, host: str, user: str, password: str, *, target_ctm: str | None = None, target_agent: str | None = None, test_on_build: bool | None = None, no_test_on_deploy: bool | None = None, description: str | None = None, centralized: bool | None = None, port: int | None = None, secured_connection: bool | None = None)#

Bases: ConnectionProfileAirflow

host: str#

object_name: str#

password: str#

port: int#

secured_connection: bool#

user: str#

class aapi.connectionprofile.ConnectionProfileAzure(object_name: str, subscription_id: str, application_id: str, password: str, user: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, active_directory_domain_name: str = None, batch: Batch = None)#

class Batch(batch_account_name: str, batch_account_key: str, location: str)#

Bases: AAPIObject

batch_account_key: str#

batch_account_name: str#

location: str#

active_directory_domain_name: str#

application_id: str#

batch: Batch#

object_name: str#

password: str#

subscription_id: str#

user: str#

connection_idle_time: str#

connection_retry_num: str#

connection_retry_time_out: str#

max_concurrent_connections: str#

object_name: str#

password: str#

user: str#

database_name: str#

database_type: str#

database_version: str#

host: str#

object_name: str#

port: str#

database_name: str#

driver: str#

host: str#

object_name: str#

port: str#

class aapi.connectionprofile.ConnectionProfileDatabaseMSSql(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, user: str = None, password: str = None, max_concurrent_connections: str = None, connection_retry_num: str = None, connection_retry_time_out: str = None, connection_idle_time: str = None, database_type: str = None, database_version: str = None, host: str = None, port: str = None, authentication_type: AuthenticationType = None, database_name: str = None, secure: str = None)#

class AuthenticationType(value)#

Bases: Enum

An enumeration.

NTLM2_Windows_Authentication = 'NTLM2_Windows_Authentication'#

SQL_Server_Authentication = 'SQL_Server_Authentication'#

Windows_Authentication = 'Windows_Authentication'#

authentication_type: AuthenticationType#

database_name: str#

database_type: str#

database_version: str#

host: str#

object_name: str#

port: str#

secure: str#

class aapi.connectionprofile.ConnectionProfileDatabaseMSSqlSSIS(object_name: str, skip_packages_test: bool, ssis: List[Package], *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, user: str = None, password: str = None, max_concurrent_connections: str = None, connection_retry_num: str = None, connection_retry_time_out: str = None, connection_idle_time: str = None, database_type: str = None, database_version: str = None, host: str = None, port: str = None, authentication_type: AuthenticationType = None, database_name: str = None, secure: str = None)#

Bases: ConnectionProfileDatabaseMSSql

object_name: str#

skip_packages_test: bool#

ssis: List[Package]#

database_version: str#

object_name: str#

Bases: ConnectionProfileDatabaseOracle

connection_string: str#

object_name: str#

Bases: ConnectionProfileDatabaseOracle

host: str#

object_name: str#

port: str#

sid: str#

Bases: ConnectionProfileDatabaseOracle

host: str#

object_name: str#

port: str#

service_name: str#

database_name: str#

database_type: str#

database_version: str#

host: str#

object_name: str#

port: str#

database_name: str#

database_type: str#

database_version: str#

host: str#

object_name: str#

port: str#

class aapi.connectionprofile.ConnectionProfileFileTransfer(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None)#

additional_parameters: List[PackageParams]#

conntype: str#

home_directory: str#

host_name: str#

object_name: str#

os_type: str#

passphrase: str#

password: str#

port: str#

private_key_name: str#

user: str#

verify_bytes: bool#

verify_checksum: bool#

verify_destination: bool#

workload_automation_groups: List[str]#

workload_automation_users: List[str]#

class aapi.connectionprofile.ConnectionProfileFileTransferAS2(object_name: str, partner_as2_id: str, partner_destination_url: str, partner_certificate_alias: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, sign_message_parameters: SignMessageParameters = None, encrypt_message_parameters: EncryptMessageParameters = None, compress_message: bool = None, request_receipt_parameters: RequestReceiptParameters = None, send_message_timeout: int = None, async_mdn_timeout: int = None)#

class EncryptMessageParameters(*, encrypt_message: bool = None, encryption_algorithm: EncryptionAlgorithm = None)#

Bases: AAPIObject

class EncryptionAlgorithm(value)#

Bases: Enum

An enumeration.

AES128_CBC = 'AES128_CBC'#

AES128_GCM = 'AES128_GCM'#

AES192_CBC = 'AES192_CBC'#

AES192_GCM = 'AES192_GCM'#

AES256_CBC = 'AES256_CBC'#

AES256_GCM = 'AES256_GCM'#

CAST5_CBC = 'CAST5_CBC'#

IDEA_CBC = 'IDEA_CBC'#

RC2_CBC = 'RC2_CBC'#

tripleDES_DES_EDE3 = 'tripleDES_DES_EDE3'#

encrypt_message: bool#

encryption_algorithm: EncryptionAlgorithm#

class RequestReceiptParameters(*, request_receipt: bool = None, sign: Sign = None, mode: Mode = None)#

Bases: AAPIObject

class Mode(value)#

Bases: Enum

An enumeration.

Asynchronous = 'Asynchronous'#

Synchronous = 'Synchronous'#

class Sign(value)#

Bases: Enum

An enumeration.

Signed = 'Signed'#

Unsigned = 'Unsigned'#

mode: Mode#

request_receipt: bool#

sign: Sign#

class SignMessageParameters(*, sign_message: bool = None, signature_algorithm: SignatureAlgorithm = None)#

Bases: AAPIObject

class SignatureAlgorithm(value)#

Bases: Enum

An enumeration.

RSA_with_MD5 = 'RSA_with_MD5'#

RSA_with_SHA_1 = 'RSA_with_SHA_1'#

RSA_with_SHA_224 = 'RSA_with_SHA_224'#

RSA_with_SHA_256 = 'RSA_with_SHA_256'#

RSA_with_SHA_384 = 'RSA_with_SHA_384'#

RSA_with_SHA_512 = 'RSA_with_SHA_512'#

sign_message: bool#

signature_algorithm: SignatureAlgorithm#

async_mdn_timeout: int#

compress_message: bool#

encrypt_message_parameters: EncryptMessageParameters#

object_name: str#

partner_as2_id: str#

partner_certificate_alias: str#

partner_destination_url: str#

request_receipt_parameters: RequestReceiptParameters#

send_message_timeout: int#

sign_message_parameters: SignMessageParameters#

class aapi.connectionprofile.ConnectionProfileFileTransferAzure(object_name: str, azure_account_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None)#

azure_account_name: str#

azure_credential_method: str#

azure_endpoint: str#

azure_storage_type: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureAdCertificate(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_tenant_id: str = None, azure_client_id: str = None, azure_client_certificate_format: str = None, azure_client_certificate_path: str = None, azure_client_certificate_password: str = None)#

azure_client_certificate_format: str#

azure_client_certificate_password: str#

azure_client_certificate_path: str#

azure_client_id: str#

azure_tenant_id: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureAdClientSecret(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_tenant_id: str = None, azure_client_id: str = None, azure_client_secret: str = None)#

azure_client_id: str#

azure_client_secret: str#

azure_tenant_id: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureAdUserPass(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_tenant_id: str = None, azure_client_id: str = None, azure_user_name_ad: str = None, azure_user_password_ad: str = None)#

azure_client_id: str#

azure_tenant_id: str#

azure_user_name_ad: str#

azure_user_password_ad: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureConnectionString(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_account_connection_string: str = None)#

azure_account_connection_string: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureManagedIdentity(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_tenant_id: str = None, azure_client_id: str = None)#

azure_client_id: str#

azure_tenant_id: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureSharedAccessSignature(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_account_sas_token: str = None)#

azure_account_sas_token: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferAzureSharedKey(azure_account_name: str, object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, azure_storage_type: str = None, azure_endpoint: str = None, azure_credential_method: str = None, azure_account_access_key: str = None)#

azure_account_access_key: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferDualEndPoint(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, verify_checksum: bool = None, endpoint_src_ftp_list: List[EndpointSrcFtp] = NOTHING, endpoint_dest_ftp_list: List[EndpointDestFtp] = NOTHING, endpoint_src_ftps_list: List[EndpointSrcFtps] = NOTHING, endpoint_dest_ftps_list: List[EndpointDestFtps] = NOTHING, endpoint_src_sftp_list: List[EndpointSrcSftp] = NOTHING, endpoint_dest_sftp_list: List[EndpointDestSftp] = NOTHING, endpoint_src_local_list: List[EndpointSrcLocal] = NOTHING, endpoint_dest_local_list: List[EndpointDestLocal] = NOTHING)#

endpoint_dest_ftp_list: List[EndpointDestFtp]#

endpoint_dest_ftps_list: List[EndpointDestFtps]#

endpoint_dest_local_list: List[EndpointDestLocal]#

endpoint_dest_sftp_list: List[EndpointDestSftp]#

endpoint_src_ftp_list: List[EndpointSrcFtp]#

endpoint_src_ftps_list: List[EndpointSrcFtps]#

endpoint_src_local_list: List[EndpointSrcLocal]#

endpoint_src_sftp_list: List[EndpointSrcSftp]#

object_name: str#

verify_bytes: bool#

verify_checksum: bool#

verify_destination: bool#

workload_automation_groups: List[str]#

workload_automation_users: List[str]#

class aapi.connectionprofile.ConnectionProfileFileTransferFTP(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, connection_mode: ConnectionMode = None)#

class ConnectionMode(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

EPSV = 'EPSV'#

EPSVSubstituteIpAddress = 'EPSVSubstituteIpAddress'#

Passive = 'Passive'#

PassiveSubstituteIpAddress = 'PassiveSubstituteIpAddress'#

noSubstituteIP = 'noSubstituteIP'#

off = 'off'#

on = 'on'#

connection_mode: ConnectionMode#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferFTPS(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, connection_mode: ConnectionMode = None, ssl_level: SslLevel = None, ssl_implicit: bool = None, clear_data_channel: bool = None, clear_command_channel: bool = None)#

class ConnectionMode(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

EPSV = 'EPSV'#

EPSVSubstituteIpAddress = 'EPSVSubstituteIpAddress'#

Passive = 'Passive'#

PassiveSubstituteIpAddress = 'PassiveSubstituteIpAddress'#

noSubstituteIP = 'noSubstituteIP'#

off = 'off'#

on = 'on'#

class SslLevel(value)#

Bases: Enum

An enumeration.

ClientServerAuthentication = 'ClientServerAuthentication'#

NoAuthentication = 'NoAuthentication'#

ServerAuthentication = 'ServerAuthentication'#

clear_command_channel: bool#

clear_data_channel: bool#

connection_mode: ConnectionMode#

object_name: str#

ssl_implicit: bool#

ssl_level: SslLevel#

class aapi.connectionprofile.ConnectionProfileFileTransferGcs(object_name: str, gcs_service_account_key: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, gcs_service_account_key_file_name: str = None)#

gcs_service_account_key: str#

gcs_service_account_key_file_name: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferGroup(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, group_accounts: List[str] = None, connection_profile_file_transfer_as2_list: List[ConnectionProfileFileTransferAS2] = NOTHING, connection_profile_file_transfer_s3_compatible_list: List[ConnectionProfileFileTransferS3Compatible] = NOTHING, connection_profile_file_transfer_s3_amazon_list: List[ConnectionProfileFileTransferS3Amazon] = NOTHING, connection_profile_file_transfer_s3_list: List[ConnectionProfileFileTransferS3] = NOTHING, connection_profile_file_transfer_azure_list: List[ConnectionProfileFileTransferAzure] = NOTHING, connection_profile_file_transfer_gcs_list: List[ConnectionProfileFileTransferGcs] = NOTHING, connection_profile_file_transfer_sftp_list: List[ConnectionProfileFileTransferSFTP] = NOTHING, connection_profile_file_transfer_ftps_list: List[ConnectionProfileFileTransferFTPS] = NOTHING, connection_profile_file_transfer_ftp_list: List[ConnectionProfileFileTransferFTP] = NOTHING)#

connection_profile_file_transfer_as2_list: List[ConnectionProfileFileTransferAS2]#

connection_profile_file_transfer_azure_list: List[ConnectionProfileFileTransferAzure]#

connection_profile_file_transfer_ftp_list: List[ConnectionProfileFileTransferFTP]#

connection_profile_file_transfer_ftps_list: List[ConnectionProfileFileTransferFTPS]#

connection_profile_file_transfer_gcs_list: List[ConnectionProfileFileTransferGcs]#

connection_profile_file_transfer_s3_amazon_list: List[ConnectionProfileFileTransferS3Amazon]#

connection_profile_file_transfer_s3_compatible_list: List[ConnectionProfileFileTransferS3Compatible]#

connection_profile_file_transfer_s3_list: List[ConnectionProfileFileTransferS3]#

connection_profile_file_transfer_sftp_list: List[ConnectionProfileFileTransferSFTP]#

group_accounts: List[str]#

object_name: str#

workload_automation_groups: List[str]#

workload_automation_users: List[str]#

class aapi.connectionprofile.ConnectionProfileFileTransferLocal(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None)#

object_name: str#

class aapi.connectionprofile.ConnectionProfileFileTransferS3(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, access_key: str = None, secret_access_key: str = None, s3_storage_type: str = None)#

access_key: str#

object_name: str#

s3_storage_type: str#

secret_access_key: str#

class aapi.connectionprofile.ConnectionProfileFileTransferS3Amazon(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, access_key: str = None, secret_access_key: str = None, s3_storage_type: str = None, region: str = None)#

Bases: ConnectionProfileFileTransferS3

object_name: str#

region: str#

class aapi.connectionprofile.ConnectionProfileFileTransferS3Compatible(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, access_key: str = None, secret_access_key: str = None, s3_storage_type: str = None, rest_end_point: str = None)#

Bases: ConnectionProfileFileTransferS3

object_name: str#

rest_end_point: str#

class aapi.connectionprofile.ConnectionProfileFileTransferSFTP(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, host_name: str = None, os_type: str = None, user: str = None, port: str = None, home_directory: str = None, password: str = None, conntype: str = None, workload_automation_users: List[str] = None, workload_automation_groups: List[str] = None, verify_bytes: bool = None, verify_destination: bool = None, private_key_name: str = None, passphrase: str = None, verify_checksum: bool = None, additional_parameters: List[PackageParams] = None, ssh_compression: bool = None)#

object_name: str#

ssh_compression: bool#

class aapi.connectionprofile.ConnectionProfileHadoop(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, run_as: str = None, key_tab_path: str = None, sqoop: Sqoop = None, hive: Hive = None, tajo: Tajo = None, oozie: Oozie = None, spark: Spark = None)#

class Hive(*, database_name: str = None, host: str = None, port: str = None, user: str = None, password: str = None, principal: str = None, connection_definitions_type: ConnectionDefinitionsType = None, connection_string: str = None)#

Bases: AAPIObject

class ConnectionDefinitionsType(value)#

Bases: Enum

An enumeration.

Properties = 'Properties'#

String = 'String'#

connection_definitions_type: ConnectionDefinitionsType#

connection_string: str#

database_name: str#

host: str#

password: str#

port: str#

principal: str#

user: str#

class Oozie(*, host: str = None, port: str = None, ssl_enabled: bool = None, extraction_rules: List[ExtractRule] = None)#

Bases: AAPIObject

extraction_rules: List[ExtractRule]#

host: str#

port: str#

ssl_enabled: bool#

class Spark(*, custom_path: str | None = None)#

Bases: AAPIObject

custom_path: str#

Bases: AAPIObject

connection_string: str#

database_host: str#

database_name: str#

database_port: str#

database_type: bool#

database_vendor: str#

driver_class: str#

password: str#

password_file: str#

user: str#

class Tajo(*, binary_path: str | None = None, database_name: str | None = None, master_server_name: str | None = None, master_server_port: str | None = None)#

Bases: AAPIObject

binary_path: str#

database_name: str#

master_server_name: str#

master_server_port: str#

hive: Hive#

key_tab_path: str#

object_name: str#

oozie: Oozie#

run_as: str#

spark: Spark#

sqoop: Sqoop#

tajo: Tajo#

class aapi.connectionprofile.ConnectionProfileInformatica(object_name: str, host: str, user: str, power_center_domain: str, repository: str, integration_service: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, port: int = None, password: str = None, security_domain: str = None, max_concurrent_connections: int = None, connection_type: ConnectionType = None)#

class ConnectionType(value)#

Bases: Enum

An enumeration.

HTTP = 'HTTP'#

HTTPS = 'HTTPS'#

connection_type: ConnectionType#

host: str#

integration_service: str#

max_concurrent_connections: int#

object_name: str#

password: str#

port: int#

power_center_domain: str#

repository: str#

security_domain: str#

user: str#

application_servers: List[str]#

domain_password: str#

object_name: str#

password: str#

people_tools_version: str#

user: str#

class aapi.connectionprofile.ConnectionProfileSAP(object_name: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, user: str = None, password: str = None, sap_client: str = None, language: str = None, xbp_version: str = None, app_version: str = None, sap_response_time_out: str = None, use_extended: bool = None, is_solution_manager_connection_profile: bool = None, solution_manager_connection_profile: str = None, group_logon: GroupLogon = None, application_server_logon: ApplicationServerLogon = None, secured_network_connection: SecuredNetworkConnection = None, sap_router: str = None)#

class ApplicationServerLogon(*, host: str | None = None, system_number: str | None = None, sapr3_use_logon_group: str | None = None)#

Bases: AAPIObject

host: str#

sapr3_use_logon_group: str#

system_number: str#

class GroupLogon(*, system_id: str | None = None, message_server_host_name: str | None = None, group_name: str | None = None, sapr3_use_logon_group: str | None = None)#

Bases: AAPIObject

group_name: str#

message_server_host_name: str#

sapr3_use_logon_group: str#

system_id: str#

Bases: AAPIObject

quality_of_protection: str#

snc_lib: str#

snc_mode: str#

snc_my_name: str#

snc_partner_name: str#

app_version: str#

application_server_logon: ApplicationServerLogon#

group_logon: GroupLogon#

is_solution_manager_connection_profile: bool#

language: str#

object_name: str#

password: str#

sap_client: str#

sap_response_time_out: str#

sap_router: str#

secured_network_connection: SecuredNetworkConnection#

solution_manager_connection_profile: str#

use_extended: bool#

user: str#

xbp_version: str#

cm_container_port: str#

http_authentication: str#

http_non_proxy_hosts: str#

http_proxy_host: str#

http_proxy_port: str#

object_name: str#

class aapi.connectionprofile.ConnectionProfileWebServices(object_name: str, service_type: ServiceType, location: str, *, target_ctm: str = None, target_agent: str = None, test_on_build: bool = None, no_test_on_deploy: bool = None, description: str = None, centralized: bool = None, old_account_name: str = None, http_authentication: str = None, login_url: str = None, login_header: str = None, login_body: str = None, job_preset: str = None)#

class ServiceType(value)#

Bases: Enum

An enumeration.

File = 'File'#

Rest = 'Rest'#

WebServices = 'WebServices'#

http_authentication: str#

job_preset: str#

location: str#

login_body: str#

login_header: str#

login_url: str#

object_name: str#

old_account_name: str#

service_type: ServiceType#

aapi.ctbruledata module#

class aapi.ctbruledata.ActionControlMAnalyzerRule(object_name: str, name: str, *, arg: str | None = None)#

Bases: AAPIObject

arg: str#

name: str#

object_name: str#

aapi.date module#

class aapi.date.Date(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.definitionitemdetails module#

class aapi.definitionitemdetails.DefinitionItemDetails(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.deleteevents module#

class aapi.deleteevents.DeleteEvents(events: List[EventOutDelete])#

Bases: AAPIObject

events: List[EventOutDelete]#

object_name: str#

aapi.disallowedoptions module#

class aapi.disallowedoptions.DisallowedOptions(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.do module#

class aapi.do.Do(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.donotify module#

class aapi.donotify.ActionNotify(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None)#

Bases: AAPIObject

class Destination(value)#

Bases: Enum

An enumeration.

Alerts = 'Alerts'#

Console = 'Console'#

JobLog = 'JobLog'#

class Urgency(value)#

Bases: Enum

An enumeration.

Regular = 'Regular'#

Urgent = 'Urgent'#

VeryUrgent = 'VeryUrgent'#

destination: Destination#

message: str#

object_name: str#

urgency: Urgency#

aapi.driver module#

class aapi.driver.DriverJdbcDatabase(object_name: str, target_agent: str, *, target_ctm: str | None = None, string_template: str | None = None, driver_jars_folder: str | None = None, class_name: str | None = None, line_comment: str | None = None, statement_separator: str | None = None)#

Bases: AAPIObject

class_name: str#

driver_jars_folder: str#

line_comment: str#

object_name: str#

statement_separator: str#

string_template: str#

target_agent: str#

target_ctm: str#

aapi.endpoint module#

class aapi.endpoint.Endpoint(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None)#

Bases: AAPIObject

class OsType(value)#

Bases: Enum

An enumeration.

Tandem = 'Tandem'#

additional_parameters: List[PackageParams]#

conntype: str#

home_directory: str#

host_name: str#

object_name: str#

os_type: OsType#

passphrase: str#

password: str#

port: str#

private_key_name: str#

user: str#

class aapi.endpoint.EndpointDest(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None)#

Bases: Endpoint

object_name: str#

class aapi.endpoint.EndpointDestFtp(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None, connection_mode: ConnectionMode = None)#

Bases: EndpointDest

class ConnectionMode(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

EPSV = 'EPSV'#

EPSVSubstituteIpAddress = 'EPSVSubstituteIpAddress'#

Passive = 'Passive'#

PassiveSubstituteIpAddress = 'PassiveSubstituteIpAddress'#

noSubstituteIP = 'noSubstituteIP'#

off = 'off'#

on = 'on'#

connection_mode: ConnectionMode#

object_name: str#

class aapi.endpoint.EndpointDestFtps(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None, connection_mode: ConnectionMode = None, ssl_level: SslLevel = None, ssl_implicit: bool = None, clear_data_channel: bool = None, clear_command_channel: bool = None)#

Bases: EndpointDest

class ConnectionMode(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

EPSV = 'EPSV'#

EPSVSubstituteIpAddress = 'EPSVSubstituteIpAddress'#

Passive = 'Passive'#

PassiveSubstituteIpAddress = 'PassiveSubstituteIpAddress'#

noSubstituteIP = 'noSubstituteIP'#

off = 'off'#

on = 'on'#

class SslLevel(value)#

Bases: Enum

An enumeration.

ClientServerAuthentication = 'ClientServerAuthentication'#

NoAuthentication = 'NoAuthentication'#

ServerAuthentication = 'ServerAuthentication'#

clear_command_channel: bool#

clear_data_channel: bool#

connection_mode: ConnectionMode#

object_name: str#

ssl_implicit: bool#

ssl_level: SslLevel#

class aapi.endpoint.EndpointDestLocal(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None)#

Bases: EndpointDest

object_name: str#

class aapi.endpoint.EndpointDestSftp(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None, ssh_compression: bool = None)#

Bases: EndpointDest

object_name: str#

ssh_compression: bool#

class aapi.endpoint.EndpointSrc(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None)#

Bases: Endpoint

object_name: str#

class aapi.endpoint.EndpointSrcFtp(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None, connection_mode: ConnectionMode = None)#

Bases: EndpointSrc

class ConnectionMode(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

EPSV = 'EPSV'#

EPSVSubstituteIpAddress = 'EPSVSubstituteIpAddress'#

Passive = 'Passive'#

PassiveSubstituteIpAddress = 'PassiveSubstituteIpAddress'#

noSubstituteIP = 'noSubstituteIP'#

off = 'off'#

on = 'on'#

connection_mode: ConnectionMode#

object_name: str#

class aapi.endpoint.EndpointSrcFtps(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None, connection_mode: ConnectionMode = None, ssl_level: SslLevel = None, ssl_implicit: bool = None, clear_data_channel: bool = None, clear_command_channel: bool = None)#

Bases: EndpointSrc

class ConnectionMode(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

EPSV = 'EPSV'#

EPSVSubstituteIpAddress = 'EPSVSubstituteIpAddress'#

Passive = 'Passive'#

PassiveSubstituteIpAddress = 'PassiveSubstituteIpAddress'#

noSubstituteIP = 'noSubstituteIP'#

off = 'off'#

on = 'on'#

class SslLevel(value)#

Bases: Enum

An enumeration.

ClientServerAuthentication = 'ClientServerAuthentication'#

NoAuthentication = 'NoAuthentication'#

ServerAuthentication = 'ServerAuthentication'#

clear_command_channel: bool#

clear_data_channel: bool#

connection_mode: ConnectionMode#

object_name: str#

ssl_implicit: bool#

ssl_level: SslLevel#

class aapi.endpoint.EndpointSrcLocal(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None)#

Bases: EndpointSrc

object_name: str#

class aapi.endpoint.EndpointSrcSftp(object_name: str, *, user: str = None, os_type: OsType = None, port: str = None, home_directory: str = None, host_name: str = None, password: str = None, conntype: str = None, private_key_name: str = None, passphrase: str = None, additional_parameters: List[PackageParams] = None, ssh_compression: bool = None)#

Bases: EndpointSrc

object_name: str#

ssh_compression: bool#

aapi.event module#

class aapi.event.Event(*, event: str = None, date: Date = None)#

Bases: AAPIObject

class Date(value)#

Bases: Enum

An enumeration.

AnyDate = 'AnyDate'#

NextOrderDate = 'NextOrderDate'#

NoDate = 'NoDate'#

OrderDate = 'OrderDate'#

PreviousOrderDate = 'PreviousOrderDate'#

date: Date#

event: str#

object_name: str#

class aapi.event.EventAdd(object_name: str, *, event: str = None, date: Date = None)#

Bases: Event

object_name: str#

class aapi.event.EventDelete(object_name: str, *, event: str = None, date: Date = None)#

Bases: Event

object_name: str#

class aapi.event.EventIn(*, event: str = None, date: Date = None)#: Bases: Event

class aapi.event.EventOut(*, event: str = None, date: Date = None)#: Bases: Event

class aapi.event.EventOutAdd(*, event: str = None, date: Date = None)#: Bases: EventOut

class aapi.event.EventOutDelete(*, event: str = None, date: Date = None)#: Bases: EventOut

aapi.extractrule module#

Bases: AAPIObject

folder_name: str#

job_name: str#

rule_name: str#

work_flow_name: str#

work_flow_user_name: str#

aapi.filetransfer module#

class aapi.filetransfer.FileTransfer(*, src: str = None, dest: str = None, as2_subject: str = None, as2_message: str = None, transfer_option: TransferOption = None, transfer_type: TransferType = None, file_watcher_options: FileWatcherOptions = None, pre_command_src: PreCommandSrc = None, post_command_src: PostCommandSrc = None, pre_command_dest: PreCommandDest = None, post_command_dest: PostCommandDest = None, nullflds: str = None, srcopt: str = None, vernum: str = None, caseifs: str = None, trim: str = None, exclude_wildcard: str = None, if_exist: str = None, unique: str = None, dstopt: str = None, abstime: str = None, timelimit: str = None, recursive: str = None)#

Bases: AAPIObject

class FileWatcherOptions(*, min_detected_size_in_bytes: str = None, min_file_age: str = None, max_file_age: str = None, assign_file_name_to_variable: str = None, transfer_all_matching_files: bool = None, time_limit_policy: TimeLimitPolicy = None, time_limit_value: str = None)#

Bases: AAPIObject

class TimeLimitPolicy(value)#

Bases: Enum

An enumeration.

MinutesToWait = 'MinutesToWait'#

WaitUntil = 'WaitUntil'#

assign_file_name_to_variable: str#

max_file_age: str#

min_detected_size_in_bytes: str#

min_file_age: str#

time_limit_policy: TimeLimitPolicy#

time_limit_value: str#

transfer_all_matching_files: bool#

class PostCommandDest(*, action: str | None = None, arg1: str | None = None, arg2: str | None = None)#

Bases: AAPIObject

action: str#

arg1: str#

arg2: str#

class PostCommandSrc(*, action: str | None = None, arg1: str | None = None, arg2: str | None = None)#

Bases: AAPIObject

action: str#

arg1: str#

arg2: str#

class PreCommandDest(*, action: str | None = None, arg1: str | None = None, arg2: str | None = None)#

Bases: AAPIObject

action: str#

arg1: str#

arg2: str#

class PreCommandSrc(*, action: str | None = None, arg1: str | None = None, arg2: str | None = None)#

Bases: AAPIObject

action: str#

arg1: str#

arg2: str#

class TransferOption(value)#

Bases: Enum

An enumeration.

DestToSrc = 'DestToSrc'#

DestToSrcFileWatcher = 'DestToSrcFileWatcher'#

DirectoryListing = 'DirectoryListing'#

FileWatcher = 'FileWatcher'#

SrcToDest = 'SrcToDest'#

SrcToDestFileWatcher = 'SrcToDestFileWatcher'#

SyncDestToSrc = 'SyncDestToSrc'#

SyncSrcToDest = 'SyncSrcToDest'#

class TransferType(value)#

Bases: Enum

An enumeration.

Ascii = 'Ascii'#

Binary = 'Binary'#

abstime: str#

as2_message: str#

as2_subject: str#

caseifs: str#

dest: str#

dstopt: str#

exclude_wildcard: str#

file_watcher_options: FileWatcherOptions#

if_exist: str#

nullflds: str#

post_command_dest: PostCommandDest#

post_command_src: PostCommandSrc#

pre_command_dest: PreCommandDest#

pre_command_src: PreCommandSrc#

recursive: str#

src: str#

srcopt: str#

timelimit: str#

transfer_option: TransferOption#

transfer_type: TransferType#

trim: str#

unique: str#

vernum: str#

aapi.filetransfergroup module#

class aapi.filetransfergroup.FileTransferGroup(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.flow_ module#

class aapi.flow_.Flow_(object_name: str, sequence: List[str])#

Bases: AAPIObject

object_name: str#

sequence: List[str]#

aapi.folderclientdata module#

class aapi.folderclientdata.FolderClientData(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.folderjobbase module#

class aapi.folderjobbase.FolderJobBase(object_name: str, *, application: str = None, sub_application: str = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, variables: List[Dict[str, str]] = NOTHING, created_by: str = None, confirm: bool = None, priority: Priority = None)#

Bases: AAPIObject

class DocumentationFile(*, path: str | None = None, file_name: str | None = None)#

Bases: AAPIObject

file_name: str#

path: str#

class DocumentationUrl(*, url: str | None = None, file_name: str | None = None)#

Bases: AAPIObject

file_name: str#

url: str#

class Priority(value)#

Bases: Enum

An enumeration.

High = 'High'#

Low = 'Low'#

Medium = 'Medium'#

Very_High = 'Very_High'#

Very_Low = 'Very_Low'#

application: str#

confirm: bool#

created_by: str#

description: str#

documentation_file: DocumentationFile#

documentation_url: DocumentationUrl#

object_name: str#

priority: Priority#

sub_application: str#

variables: List[Dict[str, str]]#

class aapi.folderjobbase.FolderJobBaseSmart(object_name: str, *, application: str = None, sub_application: str = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, variables: List[Dict[str, str]] = NOTHING, created_by: str = None, confirm: bool = None, priority: Priority = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, rerun: Rerun = None, tag_list: List[Tag] = NOTHING, tag_folder_list: List[TagFolder] = NOTHING)#

Bases: FolderJobBase

class Rerun(*, times: str = None, from_: From = None, every: int = None, units: Units = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

class Units(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

every: int#

from_: From#

times: str#

units: Units#

class RerunIntervals(*, times: str = None, intervals: List[str] = None, from_: From = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

from_: From#

intervals: List[str]#

times: str#

class RerunSpecificTimes(*, times: str | None = None, at: List[str] | None = None, tolerance: str | None = None)#

Bases: AAPIObject

at: List[str]#

times: str#

tolerance: str#

object_name: str#

rerun: Rerun#

rerun_intervals: RerunIntervals#

rerun_specific_times: RerunSpecificTimes#

tag_folder_list: List[TagFolder]#

tag_list: List[Tag]#

class aapi.folderjobbase.SubFolder(object_name: str, *, application: str = None, sub_application: str = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, variables: List[Dict[str, str]] = NOTHING, created_by: str = None, confirm: bool = None, priority: Priority = None, path_element: PathElement = None, active_retention_policy: ActiveRetentionPolicy = None, days_keep_active: DaysKeepActive = None, reference_path: str = None, run_as: str = None, time_zone: str = None, adjust_events: str = None, when: When = None, job_list: List[Job] = NOTHING, sub_folder_list: List[SubFolder] = NOTHING, flow_list: List[Flow] = NOTHING, job_tag_list: List[JobTag] = NOTHING, resource_lock_list: List[ResourceLock] = NOTHING, if_list: List[IfBase] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING)#

Bases: FolderJobBase, AAPIJob

class ActiveRetentionPolicy(value)#

Bases: Enum

An enumeration.

CleanEndedOK = 'CleanEndedOK'#

KeepAll = 'KeepAll'#

class AdjustEvents(value)#

Bases: Enum

An enumeration.

Bridge = 'Bridge'#

Dummy = 'Dummy'#

N = 'N'#

Y = 'Y'#

class DaysKeepActive(value)#

Bases: Enum

An enumeration.

Forever = 'Forever'#

class PathElement(folder: str, *, server: str | None = None, library: str | None = None)#

Bases: AAPIObject

folder: str#

library: str#

server: str#

class When(*, specific_dates: List[str] = None, from_time: str = None, days: str = None, to_time: str = None, days_relation: DaysRelation = None, rule_based_calendars: RuleBasedCalendars = None)#

Bases: AAPIObject

class DaysRelation(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

class RuleBasedCalendars(*, relationship: Relationship = None, included: List[JobTag] = None, excluded: List[JobTag] = None)#

Bases: AAPIObject

class Relationship(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

excluded: List[JobTag]#

included: List[JobTag]#

relationship: Relationship#

days: str#

days_relation: DaysRelation#

from_time: str#

rule_based_calendars: RuleBasedCalendars#

specific_dates: List[str]#

to_time: str#

active_retention_policy: ActiveRetentionPolicy#

add_events_list: List[AddEvents]#

adjust_events: str#

days_keep_active: DaysKeepActive#

delete_events_list: List[DeleteEvents]#

events_to_add: List[AddEvents]#

events_to_delete: List[DeleteEvents]#

flow_list: List[Flow]#

if_list: List[IfBase]#

job_list: List[Job]#

job_tag_list: List[JobTag]#

notify_list: List[Notify]#

object_name: str#

path_element: PathElement#

reference_path: str#

resource_lock_list: List[ResourceLock]#

run_as: str#

sub_folder_list: List[SubFolder]#

time_zone: str#

wait_for_events: List[WaitForEvents]#

wait_for_events_list: List[WaitForEvents]#

when: When#

aapi.hostfiletransfer module#

class aapi.hostfiletransfer.HostFileTransfer(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.hostmapping module#

class aapi.hostmapping.HostMapping(object_name: str, *, host: str = None, map_to: str = None, server: Server = None)#

Bases: AAPIObject

class Server(value)#

Bases: Enum

An enumeration.

Global = 'Global'#

host: str#

map_to: str#

object_name: str#

server: Server#

aapi.if_ module#

aapi.ifbase module#

class aapi.ifbase.IfBase(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING)#

Bases: AAPIObject

do_list: List[Do]#

object_name: str#

on_list: List[On]#

class aapi.ifbase.IfBaseFolder(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING)#

Bases: IfBase

object_name: str#

class aapi.ifbase.IfCompletionStatus(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, completion_status: str = None)#

Bases: IfBaseFolder

completion_status: str#

object_name: str#

class aapi.ifbase.IfJobNotSubmitted(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, job_not_submitted: str = None)#

Bases: IfBase

job_not_submitted: str#

object_name: str#

class aapi.ifbase.IfJobOutputNotFound(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, job_output_not_found: str = None)#

Bases: IfBase

job_output_not_found: str#

object_name: str#

class aapi.ifbase.IfNumberOfExecutions(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, number_of_executions: str = None)#

Bases: IfBaseFolder

number_of_executions: str#

object_name: str#

class aapi.ifbase.IfNumberOfFailures(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, number_of_failures: str = None)#

Bases: IfBaseFolder

number_of_failures: str#

object_name: str#

class aapi.ifbase.IfNumberOfReruns(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, number_of_reruns: str = None)#

Bases: IfBaseFolder

number_of_reruns: str#

object_name: str#

class aapi.ifbase.IfOutput(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, code: str = None, statement: str = None)#

Bases: IfBaseFolder

code: str#

object_name: str#

statement: str#

class aapi.ifbase.IfVariableValue(object_name: str, *, on_list: List[On] = NOTHING, do_list: List[Do] = NOTHING, variable_name: str = None, range_variable_value: RangeVariableValue = None, variable_value: str = None, operator: Operator = None)#

Bases: IfBase

class Operator(value)#

Bases: Enum

An enumeration.

Contains = 'Contains'#

DoesNotContain = 'DoesNotContain'#

EndWith = 'EndWith'#

EqualTo = 'EqualTo'#

GreaterThan = 'GreaterThan'#

GreaterThanOrEqual = 'GreaterThanOrEqual'#

InRange = 'InRange'#

IsEmpty = 'IsEmpty'#

IsExactly = 'IsExactly'#

IsNotEmpty = 'IsNotEmpty'#

IsNotExactly = 'IsNotExactly'#

LessThan = 'LessThan'#

LessThanOrEqual = 'LessThanOrEqual'#

Like = 'Like'#

NotEqualTo = 'NotEqualTo'#

NotInRange = 'NotInRange'#

NotLike = 'NotLike'#

StartsWith = 'StartsWith'#

class RangeVariableValue(*, min: str | None = None, max: str | None = None)#

Bases: AAPIObject

max: str#

min: str#

object_name: str#

operator: Operator#

range_variable_value: RangeVariableValue#

variable_name: str#

variable_value: str#

aapi.ifcollection module#

class aapi.ifcollection.IfCollection(object_name: str, *, ifs: List[IfZOS] = None, do_list: List[Do] = NOTHING)#

Bases: AAPIObject

do_list: List[Do]#

ifs: List[IfZOS]#

object_name: str#

class aapi.ifcollection.IfCollectionZOS(object_name: str, *, ifs: List[IfZOS] = None, do_list: List[Do] = NOTHING)#

Bases: IfCollection

object_name: str#

aapi.ifrerun module#

Bases: AAPIObject

confirm: bool#

from_procedure: str#

from_program: str#

object_name: str#

to_procedure: str#

to_program: str#

aapi.internalrule module#

class aapi.internalrule.InternalRule(object_name: str, *, rule_name: str = None, include: Include = None, characters: Characters = None, exclude: Exclude = None)#

Bases: AAPIObject

class Characters(*, minimum_length: int = None, maximum_length: int = None, any: Any = None, alphanumeric: Alphanumeric = None)#

Bases: AAPIObject

class Alphanumeric(*, uppercase_letters: bool | None = None, lowercase_letters: bool | None = None, digits: bool | None = None, specific_characters: str | None = None)#

Bases: AAPIObject

digits: bool#

lowercase_letters: bool#

specific_characters: str#

uppercase_letters: bool#

class Any(*, except_for_characters: str | None = None)#

Bases: AAPIObject

except_for_characters: str#

alphanumeric: Alphanumeric#

any: Any#

maximum_length: int#

minimum_length: int#

class Exclude(*, values: List[SiteStandardPossibleValue] = None, patterns: List[str] = None)#

Bases: AAPIObject

patterns: List[str]#

values: List[SiteStandardPossibleValue]#

class Include(*, values: List[SiteStandardPossibleValue] = None, patterns: List[str] = None)#

Bases: AAPIObject

patterns: List[str]#

values: List[SiteStandardPossibleValue]#

characters: Characters#

exclude: Exclude#

include: Include#

object_name: str#

rule_name: str#

aapi.iteminfo module#

class aapi.iteminfo.ItemInfo(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.job module#

class aapi.job.Job(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: AAPIObject, AAPIJob

class DaysKeepActive(value)#

Bases: Enum

An enumeration.

Forever = 'Forever'#

class DocumentationFile(*, path: str | None = None, file_name: str | None = None)#

Bases: AAPIObject

file_name: str#

path: str#

class DocumentationUrl(*, url: str | None = None, file_name: str | None = None)#

Bases: AAPIObject

file_name: str#

url: str#

class Output(*, operation: Operation = None, destination: str = None)#

Bases: AAPIObject

class Operation(value)#

Bases: Enum

An enumeration.

Copy = 'Copy'#

Delete = 'Delete'#

Move = 'Move'#

Print = 'Print'#

destination: str#

operation: Operation#

class PathElement(folder: str, *, server: str | None = None, library: str | None = None)#

Bases: AAPIObject

folder: str#

library: str#

server: str#

class Priority(value)#

Bases: Enum

An enumeration.

High = 'High'#

Low = 'Low'#

Medium = 'Medium'#

Very_High = 'Very_High'#

Very_Low = 'Very_Low'#

class Rerun(*, times: str = None, every: str = None, from_: From = None, units: Units = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

class Units(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

every: str#

from_: From#

times: str#

units: Units#

class RerunIntervals(*, times: str = None, intervals: List[str] = None, from_: From = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

from_: From#

intervals: List[str]#

times: str#

class RerunLimit(*, times: str = None, every: int = None, from_: From = None, units: Units = None, rerun_member: str = None)#

Bases: AAPIObject

class From(value)#

Bases: Enum

An enumeration.

End = 'End'#

Start = 'Start'#

Target = 'Target'#

class Units(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

every: int#

from_: From#

rerun_member: str#

times: str#

units: Units#

class RerunSpecificTimes(*, times: str | None = None, at: List[str] | None = None, tolerance: str | None = None)#

Bases: AAPIObject

at: List[str]#

times: str#

tolerance: str#

Bases: AAPIObject

class ConfirmationCalendars(*, calendar: str = None, shift_by: str = None, exception_policy: ExceptionPolicy = None)#

Bases: AAPIObject

class ExceptionPolicy(value)#

Bases: Enum

An enumeration.

DoNotOrder = 'DoNotOrder'#

OrderAnyway = 'OrderAnyway'#

OrderOnNextConfirmedDay = 'OrderOnNextConfirmedDay'#

OrderOnPreviousConfirmedDay = 'OrderOnPreviousConfirmedDay'#

calendar: str#

exception_policy: ExceptionPolicy#

shift_by: str#

class DaysRelation(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

class RuleBasedCalendars(*, relationship: Relationship = None, included: List[JobTag] = None, excluded: List[JobTag] = None)#

Bases: AAPIObject

class Relationship(value)#

Bases: Enum

An enumeration.

AND = 'AND'#

OR = 'OR'#

excluded: List[JobTag]#

included: List[JobTag]#

relationship: Relationship#

active_period: bool#

confirmation_calendars: ConfirmationCalendars#

days: str#

days_relation: DaysRelation#

end_date: str#

from_time: str#

month_days: List[str]#

month_days_calendar: str#

months: List[str]#

rule_based_calendars: RuleBasedCalendars#

schedule: str#

specific_dates: List[str]#

start_date: str#

to_time: str#

week_days: List[str]#

week_days_calendar: str#

action_capture_output_list: List[ActionCaptureOutput]#

add_events_list: List[AddEvents]#

application: str#

condition_list: List[Condition]#

confirm: bool#

created_by: str#

critical: bool#

days_keep_active: DaysKeepActive#

delete_events_list: List[DeleteEvents]#

description: str#

documentation_file: DocumentationFile#

documentation_url: DocumentationUrl#

end_folder: bool#

event_list: List[Event]#

events_to_add: List[AddEvents]#

events_to_delete: List[DeleteEvents]#

file_name: str#

file_path: str#

host: str#

if_list: List[IfBase]#

job_tag_list: List[JobTag]#

notify_list: List[Notify]#

object_name: str#

output: Output#

path_element: PathElement#

post_command: str#

pre_command: str#

priority: Priority#

rerun: Rerun#

rerun_intervals: RerunIntervals#

rerun_limit: RerunLimit#

rerun_specific_times: RerunSpecificTimes#

resource_list: List[Resource]#

retroactive_order: bool#

run_as: str#

run_as_dummy: bool#

run_on_all_agents_in_group: bool#

sub_application: str#

time_zone: str#

variables: List[Dict[str, str]]#

wait_for_events: List[WaitForEvents]#

wait_for_events_list: List[WaitForEvents]#

when: When#

class aapi.job.JobAWS(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, append_log: bool = None)#

Bases: Job

append_log: bool#

connection_profile: str#

object_name: str#

class aapi.job.JobAWSBatch(object_name: str, job_name: str, job_definition: str, job_queue: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, append_log: bool = None, job_definition_revision: str = None, aws_job_type: AwsJobType = None, array_size: str = None, environment: List[str] = None, parameters: List[str] = None, depends_on: DependsOn = None, v_cpus: str = None, memory: str = None, job_attempts: str = None, execution_timeout: str = None, command: str = None)#

Bases: JobAWS

class AwsJobType(value)#

Bases: Enum

An enumeration.

Array = 'Array'#

Single = 'Single'#

class DependsOn(*, dependency_type: DependencyType = None, job_depends_on: str = None)#

Bases: AAPIObject

class DependencyType(value)#

Bases: Enum

An enumeration.

N_to_N = 'N_to_N'#

Sequential = 'Sequential'#

Standard = 'Standard'#

dependency_type: DependencyType#

job_depends_on: str#

array_size: str#

aws_job_type: AwsJobType#

command: str#

depends_on: DependsOn#

environment: List[str]#

execution_timeout: str#

job_attempts: str#

job_definition: str#

job_definition_revision: str#

job_name: str#

job_queue: str#

memory: str#

object_name: str#

parameters: List[str]#

v_cpus: str#

class aapi.job.JobAWSLambda(object_name: str, function_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, append_log: bool = None, version: str = None, payload: str = None, client_context_json: str = None)#

Bases: JobAWS

client_context_json: str#

function_name: str#

object_name: str#

payload: str#

version: str#

class aapi.job.JobAWSStepFunction(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, append_log: bool = None, state_machine: str = None, execution_name: str = None, input: str = None)#

Bases: JobAWS

execution_name: str#

input: str#

object_name: str#

state_machine: str#

class aapi.job.JobAirflow(object_name: str, connection_profile: str, dag_id: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, configuration_json: str = None, rerun_from_point_of_failure: bool = None, output_details: OutputDetails = None)#

Bases: Job

class OutputDetails(value)#

Bases: Enum

An enumeration.

DoNotIncludeTaskLogs = 'DoNotIncludeTaskLogs'#

IncludeAllTasksLogs = 'IncludeAllTasksLogs'#

IncludeOnlyFailedTasksLogs = 'IncludeOnlyFailedTasksLogs'#

configuration_json: str#

connection_profile: str#

dag_id: str#

object_name: str#

output_details: OutputDetails#

rerun_from_point_of_failure: bool#

class aapi.job.JobAzure(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, append_log: bool = None, connection_profile: str = None)#

Bases: Job

append_log: bool#

connection_profile: str#

object_name: str#

class aapi.job.JobAzureBatchAccount(object_name: str, job_id: str, command_line: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, append_log: bool = None, connection_profile: str = None, wallclock: Wallclock = None, max_tries: MaxTries = None, retention: Retention = None)#

Bases: JobAzure

class MaxTries(option: Option, *, count: str = None)#

Bases: AAPIObject

class Option(value)#

Bases: Enum

An enumeration.

Custom = 'Custom'#

Unlimited = 'Unlimited'#

count: str#

option: Option#

class Retention(time: str, unit: Unit)#

Bases: AAPIObject

class Unit(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

Seconds = 'Seconds'#

time: str#

unit: Unit#

class Wallclock(time: str, unit: Unit)#

Bases: AAPIObject

class Unit(value)#

Bases: Enum

An enumeration.

Days = 'Days'#

Hours = 'Hours'#

Minutes = 'Minutes'#

Seconds = 'Seconds'#

time: str#

unit: Unit#

command_line: str#

job_id: str#

max_tries: MaxTries#

object_name: str#

retention: Retention#

wallclock: Wallclock#

class aapi.job.JobAzureFunction(object_name: str, function: str, function_app: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, append_log: bool = None, connection_profile: str = None, parameters: List[Dict[str, str]] = None)#

Bases: JobAzure

function: str#

function_app: str#

object_name: str#

parameters: List[Dict[str, str]]#

class aapi.job.JobAzureLogicApps(object_name: str, logic_app_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, append_log: bool = None, connection_profile: str = None, request_body: str = None)#

Bases: JobAzure

logic_app_name: str#

object_name: str#

request_body: str#

class aapi.job.JobCommand(object_name: str, command: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, override_path: str = None, run_as_dummy: bool = None)#

Bases: Job

command: str#

object_name: str#

override_path: str#

run_as_dummy: bool#

class aapi.job.JobDatabase(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, autocommit: str = None, output_execution_log: str = None, output_sql_output: str = None, sql_output_format: str = None)#

Bases: Job

autocommit: str#

connection_profile: str#

object_name: str#

output_execution_log: str#

output_sql_output: str#

sql_output_format: str#

class aapi.job.JobDatabaseEmbeddedQuery(object_name: str, query: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, autocommit: str = None, output_execution_log: str = None, output_sql_output: str = None, sql_output_format: str = None)#

Bases: JobDatabase

object_name: str#

query: str#

class aapi.job.JobDatabaseMSSQLAgentJob(object_name: str, job_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, autocommit: str = None, output_execution_log: str = None, output_sql_output: str = None, sql_output_format: str = None, category: str = None)#

Bases: JobDatabase

category: str#

job_name: str#

object_name: str#

class aapi.job.JobDatabaseMSSQL_SSIS(object_name: str, package_source: PackageSource, package_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, autocommit: str = None, output_execution_log: str = None, output_sql_output: str = None, sql_output_format: str = None, catalog_env: str = None, config_files: List[str] = None, properties: List[Dict[str, str]] = None)#

Bases: JobDatabase

class PackageSource(value)#

Bases: Enum

An enumeration.

File_System = 'File System'#

SQL_Server = 'SQL Server'#

SSIS_Catalog = 'SSIS Catalog'#

SSIS_Package_Store = 'SSIS Package Store'#

catalog_env: str#

config_files: List[str]#

object_name: str#

package_name: str#

package_source: PackageSource#

properties: List[Dict[str, str]]#

class aapi.job.JobDatabaseSQLScript(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, autocommit: str = None, output_execution_log: str = None, output_sql_output: str = None, sql_output_format: str = None, sql_script: str = None, parameters: List[Dict[str, str]] = NOTHING)#

Bases: JobDatabase

object_name: str#

parameters: List[Dict[str, str]]#

sql_script: str#

class aapi.job.JobDatabaseStoredProcedure(object_name: str, schema: str, stored_procedure: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, autocommit: str = None, output_execution_log: str = None, output_sql_output: str = None, sql_output_format: str = None, package: str = None, parameters: List[Any] = None, return_value: str = None)#

Bases: JobDatabase

object_name: str#

package: str#

parameters: List[Any]#

return_value: str#

schema: str#

stored_procedure: str#

class aapi.job.JobDummy(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

object_name: str#

class aapi.job.JobEmbeddedScript(object_name: str, script: str, file_name: str, *, path_element: PathElement = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, override_path: str = None, run_as_dummy: bool = None)#

Bases: Job

file_name: str#

object_name: str#

override_path: str#

run_as_dummy: bool#

script: str#

class aapi.job.JobFileTransfer(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile_src: str = None, connection_profile_dest: str = None, connection_profile_dual_endpoint: str = None, file_transfers: List[FileTransfer] = NOTHING, s3_bucket_name: str = None, s3_bucket_name_src: str = None, s3_bucket_name_dest: str = None, gcs_bucket_name_src: str = None, gcs_bucket_name_dest: str = None, azure_container_name_src: str = None, azure_container_name_dest: str = None, end_job_not_ok: bool = None, rerun_from_point_of_failure: bool = None, number_of_retries: str = None)#

Bases: Job

azure_container_name_dest: str#

azure_container_name_src: str#

connection_profile_dest: str#

connection_profile_dual_endpoint: str#

connection_profile_src: str#

end_job_not_ok: bool#

file_transfers: List[FileTransfer]#

gcs_bucket_name_dest: str#

gcs_bucket_name_src: str#

number_of_retries: str#

object_name: str#

rerun_from_point_of_failure: bool#

s3_bucket_name: str#

s3_bucket_name_dest: str#

s3_bucket_name_src: str#

class aapi.job.JobFileWatcher(object_name: str, path: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, search_interval: str = None, time_limit: str = None, start_time: str = None, stop_time: str = None)#

Bases: Job

object_name: str#

path: str#

search_interval: str#

start_time: str#

stop_time: str#

time_limit: str#

class aapi.job.JobFileWatcherCreate(object_name: str, path: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, search_interval: str = None, time_limit: str = None, start_time: str = None, stop_time: str = None, minimum_size: str = None, file_size_interval: str = None, wildcard: bool = None, iterations: str = None, minimal_age: str = None, maximal_age: str = None)#

Bases: JobFileWatcher

file_size_interval: str#

iterations: str#

maximal_age: str#

minimal_age: str#

minimum_size: str#

wildcard: bool#

class aapi.job.JobFileWatcherDelete(object_name: str, path: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, search_interval: str = None, time_limit: str = None, start_time: str = None, stop_time: str = None)#: Bases: JobFileWatcher

class aapi.job.JobHadoop(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None)#

Bases: Job

class PostCommands(*, fail_job_on_command_failure: bool | None = None, commands: List[str] | None = None)#

Bases: AAPIObject

commands: List[str]#

fail_job_on_command_failure: bool#

class PreCommands(*, fail_job_on_command_failure: bool | None = None, commands: List[str] | None = None)#

Bases: AAPIObject

commands: List[str]#

fail_job_on_command_failure: bool#

connection_profile: str#

object_name: str#

post_commands: PostCommands#

pre_commands: PreCommands#

class aapi.job.JobHadoopDistCp(object_name: str, target_path: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, source_paths: List[str] = None, distcp_options: List[Dict[str, str]] = None)#

Bases: JobHadoop

distcp_options: List[Dict[str, str]]#

object_name: str#

source_paths: List[str]#

target_path: str#

class aapi.job.JobHadoopHDFSCommands(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, commands: List[Dict[str, str]] = None)#

Bases: JobHadoop

commands: List[Dict[str, str]]#

object_name: str#

class aapi.job.JobHadoopHDFSFileWatcher(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, hdfs_file_path: str = None, min_detected_size: str = None, max_wait_time: str = None)#

Bases: JobHadoop

hdfs_file_path: str#

max_wait_time: str#

min_detected_size: str#

object_name: str#

class aapi.job.JobHadoopHive(object_name: str, hive_script: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, parameters: List[Dict[str, str]] = None, hive_archives: str = None, hive_files: str = None, hive_options: List[Dict[str, str]] = None)#

Bases: JobHadoop

hive_archives: str#

hive_files: str#

hive_options: List[Dict[str, str]]#

hive_script: str#

object_name: str#

parameters: List[Dict[str, str]]#

class aapi.job.JobHadoopMapReduce(object_name: str, program_jar: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, main_class: str = None, arguments: List[str] = None)#

Bases: JobHadoop

arguments: List[str]#

main_class: str#

object_name: str#

program_jar: str#

class aapi.job.JobHadoopMapredStreaming(object_name: str, input_path: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, output_path: str = None, mapper_command: str = None, reducer_command: str = None, steaming_options: List[str] = None, general_options: List[Dict[str, str]] = None)#

Bases: JobHadoop

general_options: List[Dict[str, str]]#

input_path: str#

mapper_command: str#

object_name: str#

output_path: str#

reducer_command: str#

steaming_options: List[str]#

class aapi.job.JobHadoopOozie(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, job_properties_file: str = None, oozie_options: List[Dict[str, str]] = None)#

Bases: JobHadoop

job_properties_file: str#

object_name: str#

oozie_options: List[Dict[str, str]]#

class aapi.job.JobHadoopPig(object_name: str, pig_script: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, parameters: List[str] = None)#

Bases: JobHadoop

object_name: str#

parameters: List[str]#

pig_script: str#

class aapi.job.JobHadoopSpark(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, arguments: List[str] = None, spark_options: List[Dict[str, str]] = None)#

Bases: JobHadoop

arguments: List[str]#

object_name: str#

spark_options: List[Dict[str, str]]#

class aapi.job.JobHadoopSparkPython(object_name: str, spark_script: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, arguments: List[str] = None, spark_options: List[Dict[str, str]] = None)#

Bases: JobHadoopSpark

object_name: str#

spark_script: str#

class aapi.job.JobHadoopSparkScalaJava(object_name: str, program_jar: str, main_class: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, arguments: List[str] = None, spark_options: List[Dict[str, str]] = None)#

Bases: JobHadoopSpark

main_class: str#

object_name: str#

program_jar: str#

class aapi.job.JobHadoopSqoop(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, sqoop_command: str = None, sqoop_options: List[Dict[str, str]] = None, sqoop_archives: str = None, sqoop_files: str = None)#

Bases: JobHadoop

object_name: str#

sqoop_archives: str#

sqoop_command: str#

sqoop_files: str#

sqoop_options: List[Dict[str, str]]#

class aapi.job.JobHadoopTajo(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, arguments: List[str] = None, tajo_options: List[Dict[str, str]] = None)#

Bases: JobHadoop

arguments: List[str]#

object_name: str#

tajo_options: List[Dict[str, str]]#

class aapi.job.JobHadoopTajoInputFile(object_name: str, full_file_path: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, arguments: List[str] = None, tajo_options: List[Dict[str, str]] = None)#

Bases: JobHadoopTajo

full_file_path: str#

object_name: str#

class aapi.job.JobHadoopTajoQuery(object_name: str, open_query: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, pre_commands: PreCommands = None, post_commands: PostCommands = None, arguments: List[str] = None, tajo_options: List[Dict[str, str]] = None)#

Bases: JobHadoopTajo

object_name: str#

open_query: str#

class aapi.job.JobIBMCognos(object_name: str, connection_profile: str, jobs: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

connection_profile: str#

jobs: str#

object_name: str#

class aapi.job.JobIBMDataStage(object_name: str, connection_profile: str, project: str, data_stage_job: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

connection_profile: str#

data_stage_job: str#

object_name: str#

project: str#

class aapi.job.JobInformatica(object_name: str, connection_profile: str, repository_folder: str, workflow: str, workflow_execution_mode: WorkflowExecutionMode, workflow_restart_mode: WorkflowRestartMode, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, instance_name: str = None, os_profile: str = None, start_from_task: str = None, run_single_task: str = None, restart_from_task: str = None, depth: str = None, enable_error_details: bool = None, enable_output: bool = None, workflow_parameters_file: str = None)#

Bases: Job

class WorkflowExecutionMode(value)#

Bases: Enum

An enumeration.

RunSingleTask = 'RunSingleTask'#

RunWholeWorkflow = 'RunWholeWorkflow'#

StartFromTask = 'StartFromTask'#

class WorkflowRestartMode(value)#

Bases: Enum

An enumeration.

ForceRestart = 'ForceRestart'#

ForceRestartFromSpecificTask = 'ForceRestartFromSpecificTask'#

Recover = 'Recover'#

connection_profile: str#

depth: str#

enable_error_details: bool#

enable_output: bool#

instance_name: str#

object_name: str#

os_profile: str#

repository_folder: str#

restart_from_task: str#

run_single_task: str#

start_from_task: str#

workflow: str#

workflow_execution_mode: WorkflowExecutionMode#

workflow_parameters_file: str#

workflow_restart_mode: WorkflowRestartMode#

class aapi.job.JobJava(object_name: str, connection_profile: str, object: str, method: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, java_profile: str = None)#

Bases: Job

connection_profile: str#

java_profile: str#

method: str#

object: str#

object_name: str#

class aapi.job.JobMessaging(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None)#

Bases: Job

connection_profile: str#

object_name: str#

class aapi.job.JobMessagingFreeText(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, use_free_text_message: str = None)#

Bases: JobMessaging

object_name: str#

use_free_text_message: str#

class aapi.job.JobMessagingPreDefined(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, use_free_text_message: str = None)#

Bases: JobMessaging

object_name: str#

use_free_text_message: str#

class aapi.job.JobMessagingWaitForReply(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None)#

Bases: JobMessaging

object_name: str#

class aapi.job.JobNetBackup(object_name: str, connection_profile: str, policy_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

connection_profile: str#

object_name: str#

policy_name: str#

class aapi.job.JobOEBS(object_name: str, connection_profile: str, user_name: str, responsibility: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, single_request: SingleRequest = None, request_set: RequestSet = None)#

Bases: Job

class RequestSet(set: str)#

Bases: AAPIObject

set: str#

class SingleRequest(program_name: str)#

Bases: AAPIObject

program_name: str#

connection_profile: str#

object_name: str#

request_set: RequestSet#

responsibility: str#

single_request: SingleRequest#

user_name: str#

class aapi.job.JobOS400(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

object_name: str#

class aapi.job.JobOS400ExternalJob(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, status: Status = None, duplicate_option: DuplicateOption = None)#

Bases: JobOS400

class DuplicateOption(value)#

Bases: Enum

An enumeration.

First = 'First'#

Last = 'Last'#

class Status(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

All = 'All'#

OutputQueue = 'OutputQueue'#

Queue = 'Queue'#

duplicate_option: DuplicateOption#

object_name: str#

status: Status#

class aapi.job.JobOS400ExternalSubSystem(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400

object_name: str#

class aapi.job.JobOS400Full(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400

object_name: str#

class aapi.job.JobOS400FullCommandLine(object_name: str, command_line: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, special_environment: SpecialEnvironment = None)#

Bases: JobOS400Full

class SpecialEnvironment(value)#

Bases: Enum

An enumeration.

Native = 'Native'#

QShell = 'QShell'#

S38 = 'S38'#

command_line: str#

object_name: str#

special_environment: SpecialEnvironment#

class aapi.job.JobOS400FullDescriptionJob(object_name: str, library: str, description: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400Full

description: str#

library: str#

object_name: str#

class aapi.job.JobOS400FullExternalJob(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, status: Status = None, duplicate_option: DuplicateOption = None)#

Bases: JobOS400Full

class DuplicateOption(value)#

Bases: Enum

An enumeration.

First = 'First'#

Last = 'Last'#

class Status(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

All = 'All'#

OutputQueue = 'OutputQueue'#

Queue = 'Queue'#

duplicate_option: DuplicateOption#

object_name: str#

status: Status#

class aapi.job.JobOS400FullExternalSubSystem(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400Full

object_name: str#

class aapi.job.JobOS400FullMultipleCommands(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400Full

object_name: str#

class aapi.job.JobOS400FullProgram(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, program: str = None, library: str = None, special_environment: SpecialEnvironment = None)#

Bases: JobOS400Full

class SpecialEnvironment(value)#

Bases: Enum

An enumeration.

Native = 'Native'#

QShell = 'QShell'#

S38 = 'S38'#

library: str#

object_name: str#

program: str#

special_environment: SpecialEnvironment#

class aapi.job.JobOS400FullRestrictedStateAction(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, action: Action = None, device: str = None, batch_time_limit: str = None, command: str = None)#

Bases: JobOS400Full

class Action(value)#

Bases: Enum

An enumeration.

ExecuteCommand = 'ExecuteCommand'#

RunReclaimStorage = 'RunReclaimStorage'#

SaveEntireSystem = 'SaveEntireSystem'#

SaveOperationSystem = 'SaveOperationSystem'#

action: Action#

batch_time_limit: str#

command: str#

device: str#

object_name: str#

class aapi.job.JobOS400FullScriptFile(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, special_environment: SpecialEnvironment = None, native_script_file_location: NativeScriptFileLocation = None, i_f_s_script_file_location: IFSScriptFileLocation = None, embedded_script_file_location: EmbeddedScriptFileLocation = None)#

Bases: JobOS400Full

class EmbeddedScriptFileLocation(v_t_script_file_embedded: str, script: str, *, use_instream_jcl: str | None = None)#

Bases: AAPIObject

script: str#

use_instream_jcl: str#

v_t_script_file_embedded: str#

class IFSScriptFileLocation(v_t_script_file_i_f_s: str, path: str, script: str)#

Bases: AAPIObject

path: str#

script: str#

v_t_script_file_i_f_s: str#

class NativeScriptFileLocation(v_t_script_file_native: str, script: str, library: str, *, use_instream_jcl: str | None = None)#

Bases: AAPIObject

library: str#

script: str#

use_instream_jcl: str#

v_t_script_file_native: str#

class SpecialEnvironment(value)#

Bases: Enum

An enumeration.

Native = 'Native'#

QShell = 'QShell'#

S38 = 'S38'#

embedded_script_file_location: EmbeddedScriptFileLocation#

i_f_s_script_file_location: IFSScriptFileLocation#

native_script_file_location: NativeScriptFileLocation#

object_name: str#

special_environment: SpecialEnvironment#

class aapi.job.JobOS400FullSubSystem(object_name: str, library: str, sub_system: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400Full

library: str#

object_name: str#

sub_system: str#

class aapi.job.JobOS400FullVirtualTerminal(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, native_script_file_location: NativeScriptFileLocation = None, i_f_s_script_file_location: IFSScriptFileLocation = None, embedded_script_file_location: EmbeddedScriptFileLocation = None)#

Bases: JobOS400Full

class EmbeddedScriptFileLocation(v_t_script_file_embedded: str, script: str, *, use_instream_jcl: str | None = None)#

Bases: AAPIObject

script: str#

use_instream_jcl: str#

v_t_script_file_embedded: str#

class IFSScriptFileLocation(v_t_script_file_i_f_s: str)#

Bases: AAPIObject

v_t_script_file_i_f_s: str#

class NativeScriptFileLocation(v_t_script_file_native: str)#

Bases: AAPIObject

v_t_script_file_native: str#

embedded_script_file_location: EmbeddedScriptFileLocation#

i_f_s_script_file_location: IFSScriptFileLocation#

native_script_file_location: NativeScriptFileLocation#

object_name: str#

class aapi.job.JobOS400MultipleCommands(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobOS400

object_name: str#

class aapi.job.JobOS400Program(object_name: str, program: str, library: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, special_environment: SpecialEnvironment = None)#

Bases: JobOS400

class SpecialEnvironment(value)#

Bases: Enum

An enumeration.

Native = 'Native'#

QShell = 'QShell'#

S38 = 'S38'#

library: str#

object_name: str#

program: str#

special_environment: SpecialEnvironment#

class aapi.job.JobOS400VirtualTerminal(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, native_script_file_location: NativeScriptFileLocation = None, i_f_s_script_file_location: IFSScriptFileLocation = None, embedded_script_file_location: EmbeddedScriptFileLocation = None)#

Bases: JobOS400

class EmbeddedScriptFileLocation(v_t_script_file_embedded: str, script: str, *, use_instream_jcl: str | None = None)#

Bases: AAPIObject

script: str#

use_instream_jcl: str#

v_t_script_file_embedded: str#

class IFSScriptFileLocation(v_t_script_file_i_f_s: str)#

Bases: AAPIObject

v_t_script_file_i_f_s: str#

class NativeScriptFileLocation(v_t_script_file_native: str)#

Bases: AAPIObject

v_t_script_file_native: str#

embedded_script_file_location: EmbeddedScriptFileLocation#

i_f_s_script_file_location: IFSScriptFileLocation#

native_script_file_location: NativeScriptFileLocation#

object_name: str#

class aapi.job.JobPeopleSoft(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, user: str = None, control_id: str = None, server_name: str = None, process_type: str = None, process_name: str = None, append_to_output: bool = None, bind_variables: List[str] = None)#

Bases: Job

append_to_output: bool#

bind_variables: List[str]#

connection_profile: str#

control_id: str#

object_name: str#

process_name: str#

process_type: str#

server_name: str#

user: str#

class aapi.job.JobSAP(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None)#

Bases: Job

connection_profile: str#

object_name: str#

class aapi.job.JobSAPBW(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, detect_spawned_job: DetectSpawnedJob = None)#

Bases: JobSAP

class DetectSpawnedJob(*, detect_and_create: DetectAndCreate = None, job_name: str = None, start_spawned_job: bool = None, job_end_in_control_m_only_aftre_child_jobs_complete_on_sap: bool = None, job_completion_status_depends_on_child_jobs_status: bool = None)#

Bases: AAPIObject

class DetectAndCreate(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CurrentJobDefinition = 'CurrentJobDefinition'#

SpecificJobDefinition = 'SpecificJobDefinition'#

detect_and_create: DetectAndCreate#

job_completion_status_depends_on_child_jobs_status: bool#

job_end_in_control_m_only_aftre_child_jobs_complete_on_sap: bool#

job_name: str#

start_spawned_job: bool#

detect_spawned_job: DetectSpawnedJob#

object_name: str#

class aapi.job.JobSAPBWInfoPackage(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, detect_spawned_job: DetectSpawnedJob = None, info_package: InfoPackage = None)#

Bases: JobSAPBW

class InfoPackage(*, description: str | None = None, tech_name: str | None = None, background_job_name: str | None = None)#

Bases: AAPIObject

background_job_name: str#

description: str#

tech_name: str#

info_package: InfoPackage#

object_name: str#

class aapi.job.JobSAPBWProcessChain(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, detect_spawned_job: DetectSpawnedJob = None, rerun_option: RerunOption = None, process_chain_description: str = None, id: str = None, enable_peridoic_job: bool = None, consider_only_overall_chain_status: bool = None, retrieve_log: str = None)#

Bases: JobSAPBW

class RerunOption(value)#

Bases: Enum

An enumeration.

RerunFromStart = 'RerunFromStart'#

RestartFromFailiurePoint = 'RestartFromFailiurePoint'#

consider_only_overall_chain_status: bool#

enable_peridoic_job: bool#

id: str#

object_name: str#

process_chain_description: str#

rerun_option: RerunOption#

retrieve_log: str#

class aapi.job.JobSAPDataArchiving(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, start_condition: StartCondition = None)#

Bases: JobSAP

class StartCondition(value)#

Bases: Enum

An enumeration.

ASAP = 'ASAP'#

AfterEvent = 'AfterEvent'#

Immediate = 'Immediate'#

object_name: str#

start_condition: StartCondition#

class aapi.job.JobSAPDataArchivingDelete(object_name: str, job_name: str, archiving_object: str, session_number: int, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, start_condition: StartCondition = None, target: str = None, copy_spool_file_to: str = None)#

Bases: JobSAPDataArchiving

archiving_object: str#

copy_spool_file_to: str#

job_name: str#

object_name: str#

session_number: int#

target: str#

class aapi.job.JobSAPDataArchivingStore(object_name: str, job_name: str, archiving_object: str, session_number: int, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, start_condition: StartCondition = None, target: str = None, copy_spool_file_to: str = None)#

Bases: JobSAPDataArchiving

archiving_object: str#

copy_spool_file_to: str#

job_name: str#

object_name: str#

session_number: int#

target: str#

class aapi.job.JobSAPDataArchivingWrite(object_name: str, job_name: str, archiving_object: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, start_condition: StartCondition = None, target: str = None, job_class: JobClass = None, copy_spool_file_to: str = None, variant: Variant = None, validations: Validations = None, detect_spawned_job: DetectSpawnedJob = None)#

Bases: JobSAPDataArchiving

class DetectSpawnedJob(*, detect_and_create: DetectAndCreate = None, job_name: str = None, start_spawned_job: bool = None)#

Bases: AAPIObject

class DetectAndCreate(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CurrentJobDefinition = 'CurrentJobDefinition'#

SpecificJobDefinition = 'SpecificJobDefinition'#

detect_and_create: DetectAndCreate#

job_name: str#

start_spawned_job: bool#

class JobClass(value)#

Bases: Enum

An enumeration.

High = 'High'#

Low = 'Low'#

Medium = 'Medium'#

class Validations(*, check_sessions: bool | None = None, check_variants: bool | None = None)#

Bases: AAPIObject

check_sessions: bool#

check_variants: bool#

class Variant(*, name: str | None = None, language: str | None = None, user: str | None = None)#

Bases: AAPIObject

language: str#

name: str#

user: str#

archiving_object: str#

copy_spool_file_to: str#

detect_spawned_job: DetectSpawnedJob#

job_class: JobClass#

job_name: str#

object_name: str#

target: str#

validations: Validations#

variant: Variant#

class aapi.job.JobSAPR3(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None)#

Bases: JobSAP

new_job_name: str#

object_name: str#

class aapi.job.JobSAPR3BatchInputSession(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, exec: Exec = None, target: str = None, session: Session = None, pattern: Pattern = None)#

Bases: JobSAPR3

class Exec(value)#

Bases: Enum

An enumeration.

Server = 'Server'#

class Pattern(name: str)#

Bases: AAPIObject

name: str#

class Session(name: str)#

Bases: AAPIObject

name: str#

exec: Exec#

object_name: str#

pattern: Pattern#

session: Session#

target: str#

class aapi.job.JobSAPR3COPY(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, sap_job_name: str = None, exec: Exec = None, target: str = None, job_count: JobCount = None, job_count_specific_name: str = None, new_job_name: str = None, start_condition: StartCondition = None, after_event: str = None, after_event_parameters: str = None, rerun_from_point_of_failure: bool = None, copy_from_step: int = None, post_job_action: PostJobAction = None, detect_spawned_job: DetectSpawnedJob = None)#

Bases: JobSAPR3

Bases: AAPIObject

class DetectAndCreate(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CurrentJobDefinition = 'CurrentJobDefinition'#

SpecificJobDefinition = 'SpecificJobDefinition'#

detect_and_create: DetectAndCreate#

job_completion_status_depends_on_child_jobs_status: bool#

job_end_in_control_m_only_aftre_child_jobs_complete_on_sap: bool#

job_name: str#

start_spawned_job: bool#

class Exec(value)#

Bases: Enum

An enumeration.

Group = 'Group'#

Server = 'Server'#

class JobCount(value)#

Bases: Enum

An enumeration.

First = 'First'#

FirstScheduled = 'FirstScheduled'#

Last = 'Last'#

LastScheduled = 'LastScheduled'#

SpecificJob = 'SpecificJob'#

class PostJobAction(*, spool: Spool = None, spool_file: str = None, spool_save_to_p_d_f: bool = None, job_log: JobLog = None, job_log_file: str = None, job_completion_status_will_depend_on_application_status: bool = None)#

Bases: AAPIObject

class JobLog(value)#

Bases: Enum

An enumeration.

CopyToFile = 'CopyToFile'#

CopyToOutput = 'CopyToOutput'#

DoNotCopy = 'DoNotCopy'#

class Spool(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CopyToFile = 'CopyToFile'#

CopyToOutput = 'CopyToOutput'#

job_completion_status_will_depend_on_application_status: bool#

job_log: JobLog#

job_log_file: str#

spool: Spool#

spool_file: str#

spool_save_to_p_d_f: bool#

class StartCondition(value)#

Bases: Enum

An enumeration.

ASAP = 'ASAP'#

AfterEvent = 'AfterEvent'#

Immediate = 'Immediate'#

after_event: str#

after_event_parameters: str#

copy_from_step: int#

detect_spawned_job: DetectSpawnedJob#

exec: Exec#

job_count: JobCount#

job_count_specific_name: str#

new_job_name: str#

object_name: str#

post_job_action: PostJobAction#

rerun_from_point_of_failure: bool#

sap_job_name: str#

start_condition: StartCondition#

target: str#

class aapi.job.JobSAPR3CREATE(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, sap_job_name: str = None, exec: Exec = None, target: str = None, start_condition: StartCondition = None, after_event: str = None, after_event_parameters: str = None, rerun_from_step: int = None, job_class: JobClass = None, new_job_name: str = None, rerun_from_point_of_failure: bool = None, copy_from_step: int = None, post_job_action: PostJobAction = None, detect_spawned_job: DetectSpawnedJob = None, spool_list_recipient: SpoolListRecipient = None)#

Bases: JobSAPR3

Bases: AAPIObject

class DetectAndCreate(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CurrentJobDefinition = 'CurrentJobDefinition'#

SpecificJobDefinition = 'SpecificJobDefinition'#

detect_and_create: DetectAndCreate#

job_completion_status_depends_on_child_jobs_status: bool#

job_end_in_control_m_only_aftre_child_jobs_complete_on_sap: bool#

job_name: str#

start_spawned_job: bool#

class Exec(value)#

Bases: Enum

An enumeration.

Group = 'Group'#

Server = 'Server'#

class JobClass(value)#

Bases: Enum

An enumeration.

A = 'A'#

B = 'B'#

C = 'C'#

Bases: AAPIObject

class JobLog(value)#

Bases: Enum

An enumeration.

CopyToFile = 'CopyToFile'#

CopyToOutput = 'CopyToOutput'#

DoNotCopy = 'DoNotCopy'#

class Spool(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CopyToFile = 'CopyToFile'#

CopyToOutput = 'CopyToOutput'#

job_completion_status_will_depend_on_application_status: bool#

job_log: JobLog#

job_log_file: str#

spool: Spool#

spool_file: str#

spool_save_to_p_d_f: bool#

class SpoolListRecipient(*, recipient_type: RecipientType = None, recipient_name: str = None, recipient_copy: bool = None, recipient_blind_copy: bool = None, recipient_express: bool = None, recipt_no_forwarding: bool = None)#

Bases: AAPIObject

class RecipientType(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

ExternalAddress = 'ExternalAddress'#

FaxNumber = 'FaxNumber'#

InternetAddress = 'InternetAddress'#

PrivateDistributionList = 'PrivateDistributionList'#

RemoteMailAddress = 'RemoteMailAddress'#

SapUserName = 'SapUserName'#

SharedDistributionList = 'SharedDistributionList'#

TelexNumber = 'TelexNumber'#

X400Address = 'X400Address'#

recipient_blind_copy: bool#

recipient_copy: bool#

recipient_express: bool#

recipient_name: str#

recipient_type: RecipientType#

recipt_no_forwarding: bool#

class StartCondition(value)#

Bases: Enum

An enumeration.

ASAP = 'ASAP'#

AfterEvent = 'AfterEvent'#

Immediate = 'Immediate'#

after_event: str#

after_event_parameters: str#

copy_from_step: int#

detect_spawned_job: DetectSpawnedJob#

exec: Exec#

job_class: JobClass#

new_job_name: str#

object_name: str#

post_job_action: PostJobAction#

rerun_from_point_of_failure: bool#

rerun_from_step: int#

sap_job_name: str#

spool_list_recipient: SpoolListRecipient#

start_condition: StartCondition#

target: str#

class aapi.job.JobSAPR3MonitorSapJob(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, sap_job_name: str = None, job_count: JobCount = None, job_count_specific_name: str = None, rerun_from_point_of_failure: bool = None, copy_from_step: int = None, rerun_from_step: int = None, detect_spawned_job: DetectSpawnedJob = None)#

Bases: JobSAPR3

Bases: AAPIObject

class DetectAndCreate(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CurrentJobDefinition = 'CurrentJobDefinition'#

SpecificJobDefinition = 'SpecificJobDefinition'#

detect_and_create: DetectAndCreate#

job_completion_status_depends_on_child_jobs_status: bool#

job_end_in_control_m_only_aftre_child_jobs_complete_on_sap: bool#

job_name: str#

start_spawned_job: bool#

class JobCount(value)#

Bases: Enum

An enumeration.

SpecificJob = 'SpecificJob'#

copy_from_step: int#

detect_spawned_job: DetectSpawnedJob#

job_count: JobCount#

job_count_specific_name: str#

object_name: str#

rerun_from_point_of_failure: bool#

rerun_from_step: int#

sap_job_name: str#

class aapi.job.JobSAPR3PredefinedSapJob(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, sap_job_name: str = None, exec: Exec = None, target: str = None, start_condition: StartCondition = None, after_event: str = None, after_event_parameters: str = None, rerun_from_step: int = None, job_count: JobCount = None, job_count_specific_name: str = None, rerun_from_point_of_failure: bool = None, copy_from_step: int = None, post_job_action: PostJobAction = None, detect_spawned_job: DetectSpawnedJob = None)#

Bases: JobSAPR3

Bases: AAPIObject

class DetectAndCreate(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CurrentJobDefinition = 'CurrentJobDefinition'#

SpecificJobDefinition = 'SpecificJobDefinition'#

detect_and_create: DetectAndCreate#

job_completion_status_depends_on_child_jobs_status: bool#

job_end_in_control_m_only_aftre_child_jobs_complete_on_sap: bool#

job_name: str#

start_spawned_job: bool#

class Exec(value)#

Bases: Enum

An enumeration.

Group = 'Group'#

Server = 'Server'#

class JobCount(value)#

Bases: Enum

An enumeration.

FirstScheduled = 'FirstScheduled'#

LastScheduled = 'LastScheduled'#

SpecificJob = 'SpecificJob'#

Bases: AAPIObject

class JobLog(value)#

Bases: Enum

An enumeration.

CopyToFile = 'CopyToFile'#

CopyToOutput = 'CopyToOutput'#

DoNotCopy = 'DoNotCopy'#

class Spool(value)#

Bases: Enum

An enumeration.

Comment = 'Comment'#

CopyToFile = 'CopyToFile'#

CopyToOutput = 'CopyToOutput'#

job_completion_status_will_depend_on_application_status: bool#

job_log: JobLog#

job_log_file: str#

spool: Spool#

spool_file: str#

spool_save_to_p_d_f: bool#

class StartCondition(value)#

Bases: Enum

An enumeration.

ASAP = 'ASAP'#

AfterEvent = 'AfterEvent'#

Immediate = 'Immediate'#

after_event: str#

after_event_parameters: str#

copy_from_step: int#

detect_spawned_job: DetectSpawnedJob#

exec: Exec#

job_count: JobCount#

job_count_specific_name: str#

object_name: str#

post_job_action: PostJobAction#

rerun_from_point_of_failure: bool#

rerun_from_step: int#

sap_job_name: str#

start_condition: StartCondition#

target: str#

class aapi.job.JobSAPR3SapProfile(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None)#

Bases: JobSAPR3

object_name: str#

class aapi.job.JobSAPR3SapProfileActivate(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, profile_information: ProfileInformation = None)#

Bases: JobSAPR3SapProfile

class ProfileInformation(profile_id: str, *, profile_type: str | None = None)#

Bases: AAPIObject

profile_id: str#

profile_type: str#

object_name: str#

profile_information: ProfileInformation#

class aapi.job.JobSAPR3SapProfileDeactivate(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, profile_information: ProfileInformation = None)#

Bases: JobSAPR3SapProfile

class ProfileInformation(*, profile_type: str | None = None)#

Bases: AAPIObject

profile_type: str#

object_name: str#

profile_information: ProfileInformation#

class aapi.job.JobSAPR3TriggerSapEvent(object_name: str, event_id: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, parameter: str = None)#

Bases: JobSAPR3

event_id: str#

object_name: str#

parameter: str#

class aapi.job.JobSAPR3WatchSapEvent(object_name: str, event_id: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, new_job_name: str = None, parameter: str = None)#

Bases: JobSAPR3

event_id: str#

object_name: str#

parameter: str#

class aapi.job.JobSLAManagement(object_name: str, service_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, run_as_dummy: str = None, service_priority: str = None, job_runs_deviations_tolerance: str = None, average_run_time_tolerance: AverageRunTimeTolerance = None, complete_by: CompleteBy = None, complete_in: CompleteIn = None)#

Bases: Job

class AverageRunTimeTolerance(*, average_run_time: str = None, units: Units = None)#

Bases: AAPIObject

class Units(value)#

Bases: Enum

An enumeration.

Minutes = 'Minutes'#

Percentage = 'Percentage'#

average_run_time: str#

units: Units#

class CompleteBy(*, time: str | None = None, days: str | None = None)#

Bases: AAPIObject

days: str#

time: str#

class CompleteIn(*, time: str | None = None)#

Bases: AAPIObject

time: str#

average_run_time_tolerance: AverageRunTimeTolerance#

complete_by: CompleteBy#

complete_in: CompleteIn#

job_runs_deviations_tolerance: str#

object_name: str#

run_as_dummy: str#

service_name: str#

service_priority: str#

class aapi.job.JobScript(object_name: str, file_name: str, file_path: str, *, path_element: PathElement = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, arguments: List[str] = None, override_path: str = None, run_as_dummy: bool = None)#

Bases: Job

arguments: List[str]#

file_name: str#

file_path: str#

object_name: str#

override_path: str#

run_as_dummy: bool#

class aapi.job.JobTandem(object_name: str, job_owner: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

job_owner: str#

object_name: str#

class aapi.job.JobTandemCommand(job_owner: str, object_name: str, command_line: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobTandem

command_line: str#

object_name: str#

class aapi.job.JobTandemEmbeddedTACLScript(job_owner: str, object_name: str, t_a_c_l_script: str, script: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobTandem

object_name: str#

script: str#

t_a_c_l_script: str#

class aapi.job.JobTandemExternalProcess(job_owner: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, external_process_id: ExternalProcessId = None, external_c_p_u_p_i_n: ExternalCPUPIN = None)#

Bases: JobTandem

class ExternalCPUPIN(c_p_u_id: str)#

Bases: AAPIObject

c_p_u_id: str#

class ExternalProcessId(id: str)#

Bases: AAPIObject

id: str#

external_c_p_u_p_i_n: ExternalCPUPIN#

external_process_id: ExternalProcessId#

object_name: str#

class aapi.job.JobTandemProgram(job_owner: str, object_name: str, program: str, volume: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobTandem

object_name: str#

program: str#

volume: str#

class aapi.job.JobTandemTACLScript(job_owner: str, object_name: str, t_a_c_l_script: str, volume: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobTandem

object_name: str#

t_a_c_l_script: str#

volume: str#

class aapi.job.JobVMware(object_name: str, connection_profile: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: Job

connection_profile: str#

object_name: str#

class aapi.job.JobVMwareConfiguration(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMware

object_name: str#

class aapi.job.JobVMwareConfigurationCloneVirtualMachine(connection_profile: str, object_name: str, new_virtual_machine_name: str, target_host: str, datastore: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

datastore: str#

new_virtual_machine_name: str#

object_name: str#

target_host: str#

class aapi.job.JobVMwareConfigurationDeployTemplate(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

class aapi.job.JobVMwareConfigurationMigrateVirtualMachine(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

class aapi.job.JobVMwareConfigurationReconfigureVirtualMachine(connection_profile: str, object_name: str, number_of_c_p_us: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

number_of_c_p_us: str#

object_name: str#

class aapi.job.JobVMwarePower(connection_profile: str, object_name: str, virtual_machine_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMware

object_name: str#

virtual_machine_name: str#

class aapi.job.JobVMwarePowerOff(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwarePowerOn(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwarePowerReboot(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwarePowerReset(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwarePowerShutdown(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwarePowerStandby(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwarePowerSuspend(connection_profile: str, virtual_machine_name: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMwarePower

object_name: str#

class aapi.job.JobVMwareSnapshot(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

Bases: JobVMware

object_name: str#

class aapi.job.JobVMwareSnapshotRemove(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

class aapi.job.JobVMwareSnapshotRemoveAll(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

class aapi.job.JobVMwareSnapshotRevert(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

class aapi.job.JobVMwareSnapshotRevertToCurrent(connection_profile: str, object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

class aapi.job.JobVMwareSnapshotTake(connection_profile: str, object_name: str, snapshot_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING)#

object_name: str#

snapshot_name: str#

class aapi.job.JobWebServices(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, condition_list: List[Condition] = NOTHING, connection_profile: str = None, location: str = None, service: str = None, operation: str = None, request_type: RequestType = None, input_file: str = None, soap_header_file: str = None, override_url_endpoint: str = None, override_content_type: str = None, http_connection_timeout: str = None, preemptive_http_authentication: str = None, exclude_job_output: bool = None, include_title_in_output: bool = None, soap_request: List[str] = None, input_parameters: List[str] = None, output_parameters: List[Dict[str, str]] = None)#

Bases: Job

class RequestType(value)#

Bases: Enum

An enumeration.

FreeText = 'FreeText'#

InputFile = 'InputFile'#

Parameter = 'Parameter'#

connection_profile: str#

exclude_job_output: bool#

http_connection_timeout: str#

include_title_in_output: bool#

input_file: str#

input_parameters: List[str]#

location: str#

object_name: str#

operation: str#

output_parameters: List[Dict[str, str]]#

override_content_type: str#

override_url_endpoint: str#

preemptive_http_authentication: str#

request_type: RequestType#

service: str#

soap_header_file: str#

soap_request: List[str]#

class aapi.job.JobZOS(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, system_affinity: str = None, scheduling_environment: str = None, request_n_j_e_node: str = None, task_information: TaskInformation = None, control_d_category: str = None, prevent_n_c_t2: PreventNCT2 = None, statistics_calendar: str = None, sac: Sac = None, output_handling: OutputHandling = None, history: History = None, archiving: Archiving = None, scheduling: Scheduling = None, must_end: MustEnd = None, if_collection_list: List[IfCollection] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, step_range_list: List[StepRange] = NOTHING, condition_list: List[Condition] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING)#

Bases: Job

class Archiving(*, archive_sys_data: bool | None = None, days_to_retain_data: int | None = None, job_runs_to_retain_data: int | None = None, auto_archive: bool | None = None)#

Bases: AAPIObject

archive_sys_data: bool#

auto_archive: bool#

days_to_retain_data: int#

job_runs_to_retain_data: int#

class History(*, retention_days: str | None = None, retention_generations: str | None = None)#

Bases: AAPIObject

retention_days: str#

retention_generations: str#

class MustEnd(*, hours: str | None = None, minutes: str | None = None, days: int | None = None)#

Bases: AAPIObject

days: int#

hours: str#

minutes: str#

class OutputHandling(*, operation: Operation = None, destination: str = None, from_class: str = None)#

Bases: AAPIObject

class Operation(value)#

Bases: Enum

An enumeration.

ChangeClass = 'ChangeClass'#

Copy = 'Copy'#

Delete = 'Delete'#

Move = 'Move'#

Release = 'Release'#

destination: str#

from_class: str#

operation: Operation#

class PreventNCT2(value)#

Bases: Enum

An enumeration.

Flush = 'Flush'#

List = 'List'#

No = 'No'#

Yes = 'Yes'#

class Sac(value)#

Bases: Enum

An enumeration.

Default = 'Default'#

Next = 'Next'#

Prev = 'Prev'#

class Scheduling(*, partition_dataset: str | None = None, minimum_number_of_tracks: int | None = None)#

Bases: AAPIObject

minimum_number_of_tracks: int#

partition_dataset: str#

class TaskInformation(*, emergency_job: bool | None = None, run_as_started_task: bool | None = None)#

Bases: AAPIObject

emergency_job: bool#

run_as_started_task: bool#

action_capture_output_list: List[ActionCaptureOutput]#

add_events_list: List[AddEvents]#

archiving: Archiving#

condition_list: List[Condition]#

control_d_category: str#

delete_events_list: List[DeleteEvents]#

event_list: List[Event]#

events_to_add: List[AddEvents]#

events_to_delete: List[DeleteEvents]#

history: History#

if_collection_list: List[IfCollection]#

job_tag_list: List[JobTag]#

must_end: MustEnd#

notify_list: List[Notify]#

object_name: str#

output_handling: OutputHandling#

prevent_n_c_t2: PreventNCT2#

request_n_j_e_node: str#

resource_list: List[Resource]#

sac: Sac#

scheduling: Scheduling#

scheduling_environment: str#

statistics_calendar: str#

step_range_list: List[StepRange]#

system_affinity: str#

task_information: TaskInformation#

wait_for_events: List[WaitForEvents]#

wait_for_events_list: List[WaitForEvents]#

class aapi.job.JobZOSInStreamJCL(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, system_affinity: str = None, scheduling_environment: str = None, request_n_j_e_node: str = None, task_information: TaskInformation = None, control_d_category: str = None, prevent_n_c_t2: PreventNCT2 = None, statistics_calendar: str = None, sac: Sac = None, output_handling: OutputHandling = None, history: History = None, archiving: Archiving = None, scheduling: Scheduling = None, must_end: MustEnd = None, if_collection_list: List[IfCollection] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, step_range_list: List[StepRange] = NOTHING, condition_list: List[Condition] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, member_library: str = None, member: str = None, jcl: str = None)#

Bases: JobZOS

jcl: str#

member: str#

member_library: str#

object_name: str#

class aapi.job.JobZOSMember(object_name: str, *, path_element: PathElement = None, file_name: str = None, file_path: str = None, host: str = None, application: str = None, priority: Priority = None, critical: bool = None, confirm: bool = None, days_keep_active: DaysKeepActive = None, description: str = None, documentation_file: DocumentationFile = None, documentation_url: DocumentationUrl = None, rerun_limit: RerunLimit = None, rerun: Rerun = None, rerun_intervals: RerunIntervals = None, rerun_specific_times: RerunSpecificTimes = None, post_command: str = None, pre_command: str = None, run_as: str = None, sub_application: str = None, time_zone: str = None, variables: List[Dict[str, str]] = NOTHING, when: When = None, run_on_all_agents_in_group: bool = None, output: Output = None, run_as_dummy: bool = None, retroactive_order: bool = None, end_folder: bool = None, created_by: str = None, if_list: List[IfBase] = NOTHING, system_affinity: str = None, scheduling_environment: str = None, request_n_j_e_node: str = None, task_information: TaskInformation = None, control_d_category: str = None, prevent_n_c_t2: PreventNCT2 = None, statistics_calendar: str = None, sac: Sac = None, output_handling: OutputHandling = None, history: History = None, archiving: Archiving = None, scheduling: Scheduling = None, must_end: MustEnd = None, if_collection_list: List[IfCollection] = NOTHING, event_list: List[Event] = NOTHING, resource_list: List[Resource] = NOTHING, wait_for_events: List[WaitForEvents] = NOTHING, events_to_add: List[AddEvents] = NOTHING, events_to_delete: List[DeleteEvents] = NOTHING, notify_list: List[Notify] = NOTHING, job_tag_list: List[JobTag] = NOTHING, action_capture_output_list: List[ActionCaptureOutput] = NOTHING, step_range_list: List[StepRange] = NOTHING, condition_list: List[Condition] = NOTHING, wait_for_events_list: List[WaitForEvents] = NOTHING, add_events_list: List[AddEvents] = NOTHING, delete_events_list: List[DeleteEvents] = NOTHING, member_library: str = None, member: str = None)#

Bases: JobZOS

member: str#

member_library: str#

object_name: str#

aapi.jobsfilter module#

class aapi.jobsfilter.JobsFilter(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.jobtag module#

class aapi.jobtag.JobTag(object_name: str, *, tag_name: TagName = None)#

Bases: AAPIObject

class TagName(value)#

Bases: Enum

An enumeration.

USE_PARENT = 'USE_PARENT'#

object_name: str#

tag_name: TagName#

aapi.mail module#

class aapi.mail.ActionMail(object_name: str, *, urgency: Urgency = None, message: str = None, to: str = None, subject: str = None, cc: str = None, attach_output: bool = None)#

Bases: AAPIObject

class Urgency(value)#

Bases: Enum

An enumeration.

Regular = 'Regular'#

Urgent = 'Urgent'#

VeryUrgent = 'VeryUrgent'#

attach_output: bool#

cc: str#

message: str#

object_name: str#

subject: str#

to: str#

urgency: Urgency#

aapi.notify module#

class aapi.notify.Notify(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None)#

Bases: AAPIObject

class Destination(value)#

Bases: Enum

An enumeration.

Alerts = 'Alerts'#

Console = 'Console'#

JobLog = 'JobLog'#

class Urgency(value)#

Bases: Enum

An enumeration.

Regular = 'Regular'#

Urgent = 'Urgent'#

VeryUrgent = 'VeryUrgent'#

destination: Destination#

message: str#

object_name: str#

urgency: Urgency#

class aapi.notify.NotifyDoesNotEnd(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None, by: str = None)#

Bases: Notify

by: str#

class aapi.notify.NotifyDoesNotStart(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None, by: str = None, days: str = None)#

Bases: Notify

by: str#

days: str#

class aapi.notify.NotifyExecutionTime(object_name: str, message: str, value: str, criteria: Criteria, *, destination: Destination = None, urgency: Urgency = None)#

Bases: Notify

class Criteria(value)#

Bases: Enum

An enumeration.

GreaterThan = 'GreaterThan'#

GreaterThanAverage = 'GreaterThanAverage'#

LessThan = 'LessThan'#

LessThanAverage = 'LessThanAverage'#

criteria: Criteria#

value: str#

class aapi.notify.NotifyLateCyclicSubmit(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None, by: str = None)#

Bases: Notify

by: str#

class aapi.notify.NotifyNotOK(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None)#: Bases: Notify

class aapi.notify.NotifyOK(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None)#: Bases: Notify

class aapi.notify.NotifyRerun(object_name: str, message: str, *, destination: Destination = None, urgency: Urgency = None)#: Bases: Notify

aapi.on module#

class aapi.on.On(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.output module#

class aapi.output.ActionOutput(object_name: str, *, operation: Operation = None, destination: str = None)#

Bases: AAPIObject

class Operation(value)#

Bases: Enum

An enumeration.

Copy = 'Copy'#

Delete = 'Delete'#

Move = 'Move'#

Print = 'Print'#

destination: str#

object_name: str#

operation: Operation#

aapi.package module#

class aapi.package.Package(object_name: str, source: Source, name: str, password: str)#

Bases: AAPIObject

class Source(value)#

Bases: Enum

An enumeration.

File_System = 'File_System'#

SQL_Server = 'SQL_Server'#

SSIS_Package_Store = 'SSIS_Package_Store'#

name: str#

object_name: str#

password: str#

source: Source#

aapi.packageparams module#

class aapi.packageparams.PackageParams(name: str, value: str)#

Bases: AAPIObject

name: str#

value: str#

aapi.period module#

class aapi.period.Period(object_name: str, *, period: Period = None, years: List[Year] = None)#

Bases: AAPIObject

class Period(value)#

Bases: Enum

An enumeration.

A = 'A'#

All = 'All'#

B = 'B'#

C = 'C'#

D = 'D'#

E = 'E'#

F = 'F'#

G = 'G'#

H = 'H'#

I = 'I'#

J = 'J'#

K = 'K'#

L = 'L'#

M = 'M'#

O = 'O'#

P = 'P'#

Q = 'Q'#

R = 'R'#

S = 'S'#

T = 'T'#

U = 'U'#

V = 'V'#

W = 'W'#

X = 'X'#

Z = 'Z'#

object_name: str#

period: Period#

years: List[Year]#

aapi.possibleoptions module#

class aapi.possibleoptions.PossibleOptions(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.propertycondition module#

class aapi.propertycondition.PropertyCondition(object_name: str, *, property: Property = None, operator: Operator = None, value: str = None)#

Bases: AAPIObject

class Operator(value)#

Bases: Enum

An enumeration.

Contains = 'Contains'#

DoesNotContain = 'DoesNotContain'#

DoesNotEndsWith = 'DoesNotEndsWith'#

DoesNotEqual = 'DoesNotEqual'#

DoesNotStartsWith = 'DoesNotStartsWith'#

EndsWith = 'EndsWith'#

Equals = 'Equals'#

GreaterThan = 'GreaterThan'#

IsEmpty = 'IsEmpty'#

IsNotEmpty = 'IsNotEmpty'#

LessThan = 'LessThan'#

StartsWith = 'StartsWith'#

class Property(value)#

Bases: Enum

An enumeration.

ActivePeriod = 'ActivePeriod'#

Calendar = 'Calendar'#

CaptureVariableName = 'CaptureVariableName'#

ConfirmationCalendar = 'ConfirmationCalendar'#

DaysKeepActive = 'DaysKeepActive'#

Destination = 'Destination'#

Event = 'Event'#

ExceptionalPolicy = 'ExceptionalPolicy'#

FolderName = 'FolderName'#

FromProcedure = 'FromProcedure'#

FromProgram = 'FromProgram'#

LockName = 'LockName'#

LockType = 'LockType'#

Message = 'Message'#

MonthDaysCalendar = 'MonthDaysCalendar'#

Name = 'Name'#

NotificationType = 'NotificationType'#

OnFail = 'OnFail'#

OnOK = 'OnOK'#

PoolName = 'PoolName'#

Quantity = 'Quantity'#

Remove = 'Remove'#

ToProcedure = 'ToProcedure'#

ToProgram = 'ToProgram'#

Urgency = 'Urgency'#

Value = 'Value'#

WeekDaysCalendar = 'WeekDaysCalendar'#

object_name: str#

operator: Operator#

property: Property#

value: str#

aapi.rbcdetails module#

class aapi.rbcdetails.RbcDetails(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.remedy module#

class aapi.remedy.ActionRemedy(object_name: str, *, urgency: Urgency = None, message: str = None, summary: str = None)#

Bases: AAPIObject

class Urgency(value)#

Bases: Enum

An enumeration.

High = 'High'#

Low = 'Low'#

Medium = 'Medium'#

Urgent = 'Urgent'#

message: str#

object_name: str#

summary: str#

urgency: Urgency#

aapi.resource module#

class aapi.resource.Resource(object_name: str)#

Bases: AAPIObject

object_name: str#

class aapi.resource.ResourceLock(object_name: str, *, lock_type: LockType = None, if_fail: IfFail = None)#

Bases: Resource

class IfFail(value)#

Bases: Enum

An enumeration.

Keep = 'Keep'#

Release = 'Release'#

class LockType(value)#

Bases: Enum

An enumeration.

Exclusive = 'Exclusive'#

Shared = 'Shared'#

if_fail: IfFail#

lock_type: LockType#

object_name: str#

class aapi.resource.ResourcePool(object_name: str, *, quantity: str = None, if_fail: IfFail = None, if_ok: IfOk = None)#

Bases: Resource

class IfFail(value)#

Bases: Enum

An enumeration.

Keep = 'Keep'#

Release = 'Release'#

class IfOk(value)#

Bases: Enum

An enumeration.

Discard = 'Discard'#

Release = 'Release'#

if_fail: IfFail#

if_ok: IfOk#

object_name: str#

quantity: str#

aapi.resourcepools module#

class aapi.resourcepools.ResourcePools(object_name: str, *, resource: str = None, quantity: int = None, server: str = None, periodic_days: PeriodicDays = None, range_dates: RangeDates = None, range_dates_with_times: RangeDatesWithTimes = None, week_days_range: WeekDaysRange = None, dates_list: DatesList = None, time: Time = None, specific_time: SpecificTime = None)#

Bases: AAPIObject

class DatesList(*, dates: List[str] | None = None)#

Bases: AAPIObject

dates: List[str]#

class PeriodicDays(*, days_of_week: List[str] | None = None)#

Bases: AAPIObject

days_of_week: List[str]#

class RangeDates(*, from_date: str | None = None, to_date: str | None = None)#

Bases: AAPIObject

from_date: str#

to_date: str#

class RangeDatesWithTimes(*, from_date: str | None = None, to_date: str | None = None, from_time: str | None = None, to_time: str | None = None)#

Bases: AAPIObject

from_date: str#

from_time: str#

to_date: str#

to_time: str#

class SpecificTime(*, from_time: str | None = None, to_time: str | None = None)#

Bases: AAPIObject

from_time: str#

to_time: str#

class Time(*, time_type: TimeType = None)#

Bases: AAPIObject

class TimeType(value)#

Bases: Enum

An enumeration.

AllHours = 'AllHours'#

BetweenHours = 'BetweenHours'#

None_ = 'None_'#

time_type: TimeType#

class WeekDaysRange(*, from_day: FromDay = None, to_day: ToDay = None, from_time: str = None, to_time: str = None)#

Bases: AAPIObject

class FromDay(value)#

Bases: Enum

An enumeration.

Fri = 'Fri'#

Mon = 'Mon'#

Sat = 'Sat'#

Sun = 'Sun'#

Thu = 'Thu'#

Tue = 'Tue'#

Wed = 'Wed'#

class ToDay(value)#

Bases: Enum

An enumeration.

Fri = 'Fri'#

Mon = 'Mon'#

Sat = 'Sat'#

Sun = 'Sun'#

Thu = 'Thu'#

Tue = 'Tue'#

Wed = 'Wed'#

from_day: FromDay#

from_time: str#

to_day: ToDay#

to_time: str#

dates_list: DatesList#

object_name: str#

periodic_days: PeriodicDays#

quantity: int#

range_dates: RangeDates#

range_dates_with_times: RangeDatesWithTimes#

resource: str#

server: str#

specific_time: SpecificTime#

time: Time#

week_days_range: WeekDaysRange#

aapi.run module#

Bases: AAPIObject

controlm_server: str#

date: str#

folder: str#

job: str#

lib: str#

object_name: str#

run_as_independent_flow: bool#

variables: List[Dict[str, str]]#

aapi.runningjobs module#

class aapi.runningjobs.RunningJobs(object_name: str, *, quantity: int = None, server: Server = None, periodic_days: PeriodicDays = None, range_dates: RangeDates = None, range_dates_with_times: RangeDatesWithTimes = None, week_days_range: WeekDaysRange = None, dates_list: DatesList = None, time: Time = None, specific_time: SpecificTime = None)#

Bases: AAPIObject

class DatesList(*, dates: List[str] | None = None)#

Bases: AAPIObject

dates: List[str]#

class PeriodicDays(*, days_of_week: List[str] | None = None)#

Bases: AAPIObject

days_of_week: List[str]#

class RangeDates(*, from_date: str | None = None, to_date: str | None = None)#

Bases: AAPIObject

from_date: str#

to_date: str#

class RangeDatesWithTimes(*, from_date: str | None = None, to_date: str | None = None, from_time: str | None = None, to_time: str | None = None)#

Bases: AAPIObject

from_date: str#

from_time: str#

to_date: str#

to_time: str#

class Server(value)#

Bases: Enum

An enumeration.

Global = 'Global'#

class SpecificTime(*, from_time: str | None = None, to_time: str | None = None)#

Bases: AAPIObject

from_time: str#

to_time: str#

class Time(*, time_type: TimeType = None)#

Bases: AAPIObject

class TimeType(value)#

Bases: Enum

An enumeration.

AllHours = 'AllHours'#

BetweenHours = 'BetweenHours'#

None_ = 'None_'#

time_type: TimeType#

class WeekDaysRange(*, from_day: FromDay = None, to_day: ToDay = None, from_time: str = None, to_time: str = None)#

Bases: AAPIObject

class FromDay(value)#

Bases: Enum

An enumeration.

Fri = 'Fri'#

Mon = 'Mon'#

Sat = 'Sat'#

Sun = 'Sun'#

Thu = 'Thu'#

Tue = 'Tue'#

Wed = 'Wed'#

class ToDay(value)#

Bases: Enum

An enumeration.

Fri = 'Fri'#

Mon = 'Mon'#

Sat = 'Sat'#

Sun = 'Sun'#

Thu = 'Thu'#

Tue = 'Tue'#

Wed = 'Wed'#

from_day: FromDay#

from_time: str#

to_day: ToDay#

to_time: str#

dates_list: DatesList#

object_name: str#

periodic_days: PeriodicDays#

quantity: int#

range_dates: RangeDates#

range_dates_with_times: RangeDatesWithTimes#

server: Server#

specific_time: SpecificTime#

time: Time#

week_days_range: WeekDaysRange#

aapi.set_ module#

class aapi.set_.ActionSet(object_name: str, *, variable: str | None = None, value: str | None = None)#

Bases: AAPIObject

object_name: str#

value: str#

variable: str#

aapi.sitestandard module#

class aapi.sitestandard.SiteStandard(object_name: str, *, description: str = None, event_format: str = None, rules: List[str] = None, internal_rules: List[InternalRule] = None, business_parameters: List[BusinessParameter] = None)#

Bases: AAPIObject

business_parameters: List[BusinessParameter]#

description: str#

event_format: str#

internal_rules: List[InternalRule]#

object_name: str#

rules: List[str]#

aapi.sitestandarddata module#

class aapi.sitestandarddata.SiteStandardData(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.sitestandardoperatorvalueoptions module#

class aapi.sitestandardoperatorvalueoptions.SiteStandardOperatorValueOptions(object_name: str, *, operator: Operator = None, value: int = None)#

Bases: AAPIObject

class Operator(value)#

Bases: Enum

An enumeration.

DoesNotEqual = 'DoesNotEqual'#

Equals = 'Equals'#

Even = 'Even'#

GreaterThan = 'GreaterThan'#

LessThan = 'LessThan'#

Odd = 'Odd'#

object_name: str#

operator: Operator#

value: int#

aapi.sitestandardpolicy module#

class aapi.sitestandardpolicy.SiteStandardPolicy(object_name: str, *, description: str = None, site_standard: str = None, business_fields: List[BusinessField] = None, status: Status = None, error_level: ErrorLevel = None, apply_on: ApplyOn = None)#

Bases: AAPIObject

class ApplyOn(*, server: str | None = None, folder: str | None = None)#

Bases: AAPIObject

folder: str#

server: str#

class ErrorLevel(value)#

Bases: Enum

An enumeration.

Default = 'Default'#

Error = 'Error'#

Warning = 'Warning'#

class Status(value)#

Bases: Enum

An enumeration.

Active = 'Active'#

Not_Active = 'Not_Active'#

apply_on: ApplyOn#

business_fields: List[BusinessField]#

description: str#

error_level: ErrorLevel#

object_name: str#

site_standard: str#

status: Status#

aapi.sitestandardpolicydata module#

class aapi.sitestandardpolicydata.SiteStandardPolicyData(object_name: str)#

Bases: AAPIObject

object_name: str#

aapi.sitestandardpossiblevalue module#

class aapi.sitestandardpossiblevalue.SiteStandardPossibleValue(object_name: str, *, value: str | None = None, description: str | None = None)#

Bases: AAPIObject

description: str#

object_name: str#

value: str#

aapi.sitestandardrestriction module#

class aapi.sitestandardrestriction.SiteStandardRestriction(object_name: str)#

Bases: AAPIObject

object_name: str#

class aapi.sitestandardrestriction.SiteStandardRestrictionEnum(object_name: str)#

object_name: str#

class aapi.sitestandardrestriction.SiteStandardRestrictionNumeric(object_name: str)#

object_name: str#

class aapi.sitestandardrestriction.SiteStandardRestrictionOperatorValue(object_name: str, *, values: List[SiteStandardOperatorValueOptions] = None)#

object_name: str#

values: List[SiteStandardOperatorValueOptions]#

class aapi.sitestandardrestriction.SiteStandardRestrictionText(object_name: str)#